OrbitXInstall

Overview

The OrbitX node for n8n allows you to interact with the OrbitX API, specifically to manage contacts, send messages, handle tickets, and more.
For the resource Contatos (Contacts) and operation Criar Contato (Create Contact), this node enables you to create a new contact in your OrbitX system by providing essential details such as full name, phone number, email, and CPF (Brazilian individual taxpayer registry identification).

Common scenarios:

• Automating the onboarding of new customers or leads into your OrbitX contact list.
• Integrating CRM systems with OrbitX to keep contact information synchronized.
• Creating contacts as part of a workflow triggered by form submissions or other events.

Example use case:
When a user fills out a registration form on your website, an n8n workflow can automatically create a corresponding contact in OrbitX using this node.

---

Properties

Name	Type	Meaning
Nome Completo	String	The full name of the contact. This is required when creating a new contact.
Número	String	The contact's phone number. This is required and uniquely identifies the contact.
Email	String	The contact's email address. Optional field for additional contact information.
CPF	String	The Brazilian CPF number for the contact. Optional, used for identification purposes.

---

Output

The node returns the response from the OrbitX API after attempting to create the contact. The output is a JSON object containing the details of the created contact or any relevant status information provided by the API.

Typical output structure:

{
  "name": "Nome do contato",
  "number": "Número do contato",
  "email": "email@exemplo.com",
  "cpf": "123.456.789-00",
  "externalKey": "...",
  // ...other fields as returned by the API
}

Note: The exact fields may vary depending on the OrbitX API response.

---

Dependencies

• OrbitX API credentials are required:
  • endpointUrl: Base URL for the OrbitX API.
  • bearerToken: Bearer token for authentication.
  • secretKey: Used as an external key in requests.
• You must configure these credentials in n8n under the name orbitxApi.

---

Troubleshooting

Common issues:

• Missing required fields: If "Nome Completo" or "Número" are not provided, the node will fail before making the API request.
• Invalid credentials: If the API credentials are incorrect or expired, the node will return an authentication error.
• API errors: If the OrbitX API returns an error (e.g., duplicate contact, invalid CPF), the node will pass through the error message.

Error messages and resolutions:

• "EndpointURL inválida para extrair subdomínio": The endpoint URL configured in credentials is not valid. Ensure it starts with https:// and follows the expected format.
• HTTP 401/403 errors: Check that your bearer token is correct and has not expired.
• Validation errors from API: Review the input data for correctness (e.g., valid CPF format, unique phone number).

---

Links and References

• n8n Documentation
• OrbitX Platform (for more about the service)
• For CPF validation rules: Receita Federal - CPF

---