OrbitX icon

OrbitX

Consume OrbitX API

Overview

The OrbitX node for n8n, when configured with the Resource Template and Operation Listar Templates, allows users to retrieve a list of available WhatsApp message templates associated with a specific phone number (in E.164 format) from the OrbitX API. This is particularly useful for organizations that use WhatsApp messaging and need to dynamically fetch or display available template options before sending templated messages.

Practical scenarios:

  • Displaying available WhatsApp templates in a workflow for user selection.
  • Automating processes that depend on the availability or content of messaging templates.
  • Integrating with CRM or support systems to ensure only valid templates are used for outbound communication.

Properties

Name Type Meaning
Número (E.164) String The recipient's phone number in E.164 international format. Used to identify the account whose templates will be listed.

Output

The output is a JSON array where each item represents a WhatsApp template available for the specified number. Each object typically contains:

[
  {
    "name": "template_name",
    "value": "templateId"
  }
]
  • name: The display name of the template.
  • value: The unique identifier (templateId) for the template.

No binary data is returned by this operation.

Dependencies

  • OrbitX API credentials: You must configure the node with valid OrbitX API credentials, including:
    • endpointUrl
    • bearerToken
    • testNumber (used internally for endpoint construction)
  • n8n configuration: The OrbitX node must be installed and properly set up within your n8n instance.

Troubleshooting

Common issues:

  • Invalid Endpoint URL: If the endpointUrl credential does not match the expected format, you may see an error like EndpointURL inválida para extrair subdomínio. Ensure the URL starts with https:// and follows the required structure.
  • Authentication errors: If the bearerToken is missing or invalid, requests will fail with authorization errors. Double-check your credentials.
  • Missing or incorrect phone number: The Número (E.164) property is required. Providing an incorrectly formatted number may result in no templates being returned or an API error.

How to resolve:

  • Verify all credentials in the OrbitX node settings.
  • Ensure the phone number is in correct E.164 format (e.g., +5511999998888).
  • Check network connectivity to the OrbitX API endpoint.

Links and References

  • E.164 Number Formatting
  • For more information about OrbitX and its API, refer to your service provider’s documentation or contact their support.

Discussion