OrbitXInstall

Overview

The OrbitX node for n8n allows you to interact with the OrbitX API, specifically for managing contacts, messages, tickets, templates, and custom requests.
For the selected Resource: Contatos and Operation: Obter Contato, this node retrieves information about a contact based on their phone number.

Common scenarios:

• Looking up details of a WhatsApp contact by their phone number.
• Automating workflows that require fetching user data before sending messages or updating records.
• Integrating OrbitX contact data into CRM or support systems.

Practical example:
You can use this node in a workflow where, upon receiving a new message, you want to fetch the sender's contact details from OrbitX to enrich your automation with additional user information.

---

Properties

Name	Type	Meaning
Número	String	The phone number of the contact to retrieve. Must be provided in E.164 format (e.g., +5511999998888).

---

Output

The output is a JSON object containing the contact's details as returned by the OrbitX API.
Typical fields may include (depending on the API response):

{
  "name": "Contact Name",
  "number": "+5511999998888",
  "email": "contact@email.com",
  "cpf": "12345678900",
  // ...other possible fields
}

• The structure directly reflects the OrbitX API's /showContact endpoint response.
• No binary data is produced by this operation.

---

Dependencies

• OrbitX API credentials are required:
  • endpointUrl
  • bearerToken
  • secretKey (not used for this operation)
• You must configure the orbitxApi credential in n8n with the above values.

---

Troubleshooting

Common issues:

• Invalid or missing phone number: Ensure the "Número" property is filled and formatted correctly (E.164).
• Authentication errors: If credentials are incorrect or expired, the node will fail with an authentication error.
• API connectivity issues: Network problems or incorrect endpoint URLs can cause request failures.

Error messages and resolutions:

• "EndpointURL inválida para extrair subdomínio": Check your OrbitX API credential's endpoint URL format.
• 401 Unauthorized or similar: Verify your bearer token and other credentials.
• Contact not found: Make sure the phone number exists in OrbitX.

---

Links and References

• E.164 Phone Number Format
• For more on OrbitX API, refer to your provider's documentation or support channel.