OrbitX icon

OrbitX

Consume OrbitX API

Overview

The OrbitX node for n8n allows you to interact with the OrbitX API, specifically for managing tickets. The "Atualizar Ticket" (Update Ticket) operation enables users to update the status and assigned user of an existing ticket by providing the relevant Ticket ID, User ID, and desired Status. This is useful in customer support or helpdesk automation scenarios where ticket management needs to be integrated into automated workflows.

Practical examples:

  • Automatically updating a ticket's status to "closed" after a resolution step.
  • Assigning a ticket to a different user when certain workflow conditions are met.

Properties

Name Type Meaning
User ID String The identifier of the user to whom the ticket will be assigned.
Status Options The new status for the ticket. Possible values: pending, closed.
Ticket ID String The unique identifier of the ticket to be updated.

Output

The output is a JSON object containing the response from the OrbitX API after attempting to update the ticket. The structure depends on the API's response, but typically includes fields such as:

{
  "success": true,
  "ticketId": "12345",
  "userId": "67890",
  "status": "closed",
  // ...other possible fields returned by the API
}

If the update fails, the output may include error information as provided by the API.


Dependencies

  • OrbitX API: Requires access to the OrbitX API endpoint.
  • API Credentials: You must configure the orbitxApi credential in n8n, which should include:
    • endpointUrl: Base URL for the OrbitX API.
    • bearerToken: Bearer token for authentication.
    • secretKey: Secret key if required by other operations.

Troubleshooting

Common issues:

  • Invalid credentials: If the API credentials are incorrect or expired, the node will fail with an authentication error.
  • Missing required fields: If any of the required properties (User ID, Status, Ticket ID) are missing, the node will throw an error before making the API call.
  • Invalid Ticket ID: If the provided Ticket ID does not exist, the API may return an error indicating that the ticket was not found.
  • API errors: Any errors returned by the OrbitX API (such as permission denied, invalid status value, etc.) will be passed through in the node's output.

Error messages and resolutions:

  • "EndpointURL inválida para extrair subdomínio": Indicates a misconfigured API endpoint URL. Check your endpointUrl credential.
  • HTTP 401/403 errors: Check your bearer token and permissions.
  • Validation errors: Ensure all required fields are filled and valid.

Links and References

  • n8n Documentation
  • OrbitX API documentation (contact your OrbitX administrator for access)

Discussion