OrbitXInstall

Overview

The OrbitX node for n8n allows you to interact with the OrbitX API, specifically for managing tickets. The "Tickets" resource with the "Criar Ticket" (Create Ticket) operation enables users to create new support or service tickets in the OrbitX system. This is useful in scenarios where you want to automate ticket creation based on events, such as receiving a customer inquiry, detecting an incident, or integrating with other business processes.

Practical examples:

• Automatically creating a support ticket when a customer submits a form.
• Logging incidents from monitoring tools directly into OrbitX.
• Integrating ticket creation into onboarding workflows.

Properties

Name	Type	Meaning
Número (E.164)	String	The phone number associated with the ticket, formatted in E.164 international format.
User ID	String	The identifier of the user responsible for or related to the ticket.
Status	Options	The current status of the ticket. Possible values: pending, closed.

Output

The output is a JSON object returned by the OrbitX API after creating the ticket. The structure depends on the API response, but typically includes details about the created ticket, such as its ID, status, and any metadata provided by OrbitX.

Example output structure:

{
  "ticketId": "12345",
  "number": "+5511999999999",
  "userId": "user_001",
  "status": "pending",
  "createdAt": "2024-06-01T12:00:00Z",
  // ...other fields as defined by OrbitX API
}

Dependencies

• OrbitX API credentials:
  • endpointUrl (Base URL of the OrbitX API)
  • bearerToken (API access token)
  • secretKey (External key, if required by OrbitX)
• These credentials must be configured in n8n under the name orbitxApi.

Troubleshooting

Common issues:

• Invalid credentials: If the API credentials are incorrect or missing, the node will throw authentication errors.
• Missing required fields: All properties (Número (E.164), User ID, Status) are required. Omitting any will result in validation errors.
• API endpoint errors: If the OrbitX API is unreachable or returns an error, the node will fail with the corresponding message from the API.

Error messages and resolutions:

• "EndpointURL inválida para extrair subdomínio": The provided API endpoint URL is not valid. Check your OrbitX API credentials configuration.
• HTTP 401/403 errors: Check that your bearer token is correct and has sufficient permissions.
• Validation errors: Ensure all required input fields are filled and correctly formatted.

Links and References

• E.164 Number Formatting (Wikipedia)
• For more information about OrbitX API, refer to your organization's OrbitX API documentation or contact OrbitX support.