OrbitXInstall

Overview

The OrbitX node for n8n allows you to interact with the OrbitX API, specifically for managing tickets in this context. The "Obter Ticket" (Get Ticket) operation under the "Tickets" resource retrieves information about a ticket based on a provided phone number in E.164 format. This is useful for automating customer support workflows, tracking ticket status, or integrating ticket data into other business processes.

Practical Example:
You could use this node to automatically fetch ticket details when a customer contacts your support line, enabling agents to quickly access relevant information without manual lookup.

Properties

Name	Type	Meaning
Número (E.164)	String	The phone number in E.164 format associated with the ticket you want to retrieve.
Ticket ID	String	The unique identifier of the ticket. Required for some operations, but not for "Obter Ticket".

For the "Obter Ticket" operation, only "Número (E.164)" is required and used.

Output

The output will be a JSON object containing the details of the ticket associated with the provided phone number. The exact structure depends on the OrbitX API response, but typically includes fields such as:

{
  "ticketId": "string",
  "number": "string",
  "status": "string",
  "userId": "string",
  // ...other ticket-related fields
}

• If no ticket is found, the response may be an empty object or contain an error message, depending on the API's behavior.

Dependencies

• OrbitX API: Requires valid credentials (endpointUrl, bearerToken, and secretKey) configured in n8n.
• n8n Credentials: You must set up the "orbitxApi" credential in your n8n instance.

Troubleshooting

Common Issues:

• Invalid or missing credentials: Ensure that the OrbitX API credentials are correctly configured in n8n.
• Incorrect phone number format: The "Número (E.164)" must be in the correct international format (e.g., +5511999998888).
• No ticket found: If the number does not correspond to any ticket, the response may be empty or indicate an error.

Error Messages:

• "EndpointURL inválida para extrair subdomínio": Indicates a misconfigured endpoint URL in your credentials.
• API errors (such as authentication failures or invalid parameters) will be returned as part of the node's error output. Check the error message for guidance.

Links and References

• E.164 Number Formatting
• n8n Documentation: Credentials
• OrbitX API documentation (contact your OrbitX provider for access)