OrbitX icon

OrbitX

Consume OrbitX API

Overview

The OrbitX node for n8n allows you to interact with the OrbitX API, specifically to send private WhatsApp messages.
For the resource Mensagem Privado and operation Enviar Texto, this node sends a text message to a specified phone number in E.164 format via WhatsApp.

Common scenarios:

  • Automating customer notifications or alerts via WhatsApp.
  • Sending personalized messages to users as part of a workflow (e.g., order confirmations, reminders).
  • Integrating WhatsApp messaging into business processes without manual intervention.

Practical example:
When a new order is placed in your e-commerce system, use this node to automatically send a WhatsApp confirmation message to the customer's phone number.


Properties

Name Type Meaning
Número (E.164) String The recipient's phone number in E.164 international format (e.g., +5511999998888).
Texto String The content of the WhatsApp message to be sent.

Output

The node returns the JSON response from the OrbitX API after sending the message.
The structure of the output depends on the API's response, but typically includes information such as message status, IDs, and any error details if applicable.

Example output:

[
  {
    "status": "success",
    "messageId": "abc123",
    "to": "+5511999998888",
    "body": "Olá, seu pedido foi confirmado!"
  }
]

Note: The actual fields may vary depending on the OrbitX API.


Dependencies

  • OrbitX API: Requires valid credentials (endpointUrl, bearerToken, secretKey) configured in n8n under the credential type orbitxApi.
  • WhatsApp Account: The target number must be reachable via WhatsApp.

Troubleshooting

Common issues:

  • Invalid phone number format: Ensure the number is in E.164 format (e.g., +5511999998888).
  • Authentication errors: If credentials are missing or incorrect, the node will fail with an authentication error.
  • API errors: If the OrbitX API returns an error (e.g., rate limits, invalid parameters), the node will display the error message from the API.

Common error messages:

  • "EndpointURL inválida para extrair subdomínio": The provided endpoint URL is not valid. Check your OrbitX API credentials.
  • "401 Unauthorized": Invalid or expired bearer token. Refresh your credentials.
  • "400 Bad Request": Likely due to missing or malformed input properties.

How to resolve:

  • Double-check all required input fields.
  • Verify that your OrbitX API credentials are correct and active.
  • Ensure the recipient's number is registered on WhatsApp.

Links and References

Discussion