OrbitX icon

OrbitX

Consume OrbitX API

Actions17

Overview

The OrbitX node for n8n allows you to interact with the OrbitX API, specifically to send WhatsApp message templates.
For the resource Template and operation Enviar Template ("Send Template"), this node enables automated sending of pre-defined WhatsApp templates to specified phone numbers in E.164 format. This is useful for scenarios such as:

  • Sending transactional notifications (e.g., order confirmations, appointment reminders).
  • Automating customer engagement with standardized messages.
  • Integrating WhatsApp template messaging into business workflows.

Example use case:
A business wants to automatically send a payment reminder template to customers via WhatsApp when an invoice is due.

Properties

Name Type Meaning
Número (E.164) String The recipient's phone number in E.164 international format (e.g., +5511999998888).
Template Option The name/ID of the WhatsApp template to be sent.
Componentes (JSON) JSON The components or parameters for the template, provided as a JSON object or array.

Output

The output is the direct response from the OrbitX API after attempting to send the template message.
The structure typically includes information about the message status, IDs, and any errors returned by the API.

Example output:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "+5511999998888",
      "wa_id": "5511999998888"
    }
  ],
  "messages": [
    {
      "id": "gBEGkYiEB1VXAglK1ZEqA1YKPrU"
    }
  ]
}

Note: The actual structure 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: (Not used for this operation, but part of credentials.)
  • The node must be configured with valid OrbitX API credentials in n8n.
  • Internet access to the OrbitX API endpoint.

Troubleshooting

Common issues:

  • Invalid phone number format: Ensure the phone number is in E.164 format (e.g., +5511999998888).
  • Missing or invalid template name: The selected template must exist and be approved in your WhatsApp Business account.
  • Malformed Componentes (JSON): The template parameters must be valid JSON matching the template's expected structure.
  • Authentication errors: Invalid or expired bearer token will result in authorization failures.

Common error messages:

  • "EndpointURL inválida para extrair subdomínio": The endpoint URL in credentials is not correctly formatted. Check that it starts with https:// and contains a valid domain.
  • API returns error objects: Review the error message for details (e.g., invalid template, missing parameters).

How to resolve:

  • Double-check all input fields for correctness.
  • Validate your OrbitX API credentials.
  • Ensure the template and its parameters match what is defined in your WhatsApp Business account.

Links and References

Discussion