OrbitX icon

OrbitX

Consume OrbitX API

Overview

This node allows you to send a file to a WhatsApp group using a public URL, leveraging the OrbitX API. It is specifically designed for the "Mensagem Grupo" (Group Message) resource and the "Enviar Arquivo URL (Grupo)" (Send File via URL to Group) operation. This is useful in scenarios where you want to share documents, images, or other files with all members of a WhatsApp group without uploading the file directly—just by providing its accessible URL.

Practical examples:

  • Sending a PDF report link to a project team group.
  • Sharing an image hosted online with a customer support group.
  • Distributing a document update to a class or community group.

Properties

Name Type Meaning
Group ID String The unique identifier of the WhatsApp group to which the file will be sent.
URL do Arquivo String The publicly accessible URL of the file you wish to send to the group.
Legenda String A required caption or description that accompanies the file in the message.

Output

The output is a JSON object containing the response from the OrbitX API after attempting to send the file to the group. The structure typically includes:

{
  "success": true,
  "messageId": "string",
  "status": "sent",
  // ...other fields as returned by the API
}
  • success: Indicates if the request was successful.
  • messageId: The unique identifier of the sent message.
  • status: Status of the message (e.g., "sent").
  • Additional fields may be present depending on the API's response.

Note: No binary data is output; only structured JSON responses are provided.

Dependencies

  • OrbitX API: Requires access to the OrbitX service.
  • API Credentials: You must configure the following credentials in n8n:
    • endpointUrl (Base URL of the OrbitX API)
    • bearerToken (Authentication token)
    • secretKey (Used as externalKey)
  • n8n Configuration: The node must be set up with the correct OrbitX API credentials under the name orbitxApi.

Troubleshooting

Common Issues:

  • Invalid Group ID: If the group ID is incorrect or does not exist, the API will likely return an error indicating the group was not found.
  • Invalid or Inaccessible File URL: If the file URL is not publicly accessible or is malformed, the API may fail to fetch the file, resulting in an error.
  • Missing Required Fields: All three properties (Group ID, URL do Arquivo, Legenda) are required. Omitting any will cause the node to throw an error before making the API call.
  • Authentication Errors: If the bearer token is missing or expired, you will receive an authentication/authorization error from the API.

Error Messages and Resolutions:

  • "EndpointURL inválida para extrair subdomínio": The endpoint URL configured in credentials is invalid. Check your OrbitX API base URL.
  • "401 Unauthorized" or similar: Check your bearer token and ensure it is valid and has not expired.
  • "File not found" or "Invalid mediaUrl": Ensure the file URL is correct and accessible from the internet.

Links and References


Summary:
This node enables automated sending of files to WhatsApp groups via a URL, requiring only the group ID, file URL, and a caption. It is ideal for workflows needing to distribute files to group chats efficiently.

Discussion