OrbitX icon

OrbitX

Consume OrbitX API

Overview

The OrbitX n8n node, when configured with the resource Mensagem Privado and operation Enviar Arquivo URL, allows you to send a file to a private WhatsApp number by providing a direct URL to the file. This is particularly useful for automating the delivery of documents, images, or other files to individual users without needing to upload the file content directly—just the link and an accompanying caption.

Practical scenarios:

  • Sending invoices, receipts, or reports as downloadable links to customers.
  • Sharing promotional materials or product information via WhatsApp.
  • Automating customer support workflows that require sending files on demand.

Properties

Name Type Meaning
Número (E.164) String The recipient's phone number in E.164 format (e.g., +5511999998888).
URL do Arquivo String The direct URL to the file you want to send to the recipient.
Legenda String A mandatory caption/description to accompany the sent file.

Output

The node returns the JSON response from the OrbitX API after attempting to send the file. The structure of this output depends on the API's response but typically includes fields such as status, message ID, and any error messages if applicable. Example output might look like:

[
  {
    "status": "success",
    "messageId": "abc123",
    "to": "+5511999998888",
    "mediaUrl": "https://example.com/file.pdf",
    "body": "Here is your requested document."
  }
]

If the API call fails, the output will contain error details as provided by the OrbitX API.

Dependencies

  • OrbitX API credentials: You must configure the node with valid OrbitX API credentials (endpointUrl, bearerToken, and secretKey).
  • External service: Requires access to the OrbitX API endpoint.
  • n8n configuration: The OrbitX credential type must be set up in your n8n instance.

Troubleshooting

Common issues:

  • Invalid phone number format: Ensure the phone number is in E.164 format (e.g., +5511999998888).
  • Missing or invalid file URL: The URL do Arquivo must be a publicly accessible and valid URL.
  • Empty caption: The Legenda field is required; leaving it blank will cause the request to fail.
  • Authentication errors: If credentials are incorrect or expired, the API will return an authentication error.
  • API endpoint misconfiguration: Double-check the endpointUrl in your OrbitX credentials.

Common error messages:

  • "EndpointURL inválida para extrair subdomínio": Indicates a misconfigured or malformed API endpoint URL.
  • Authentication errors (e.g., 401 Unauthorized): Check your bearer token and secret key.
  • File not found or inaccessible: Make sure the file URL is correct and accessible from the OrbitX servers.

Links and References

Discussion