OrbitX icon

OrbitX

Consume OrbitX API
Join our community

Actions17

Overview

The OrbitX node for n8n, when configured with the resource Mensagem Grupo and operation Enviar Arquivo (Grupo), allows you to send a file to a WhatsApp group via the OrbitX API. This is particularly useful for automating workflows where files (such as reports, images, or documents) need to be distributed to group chats on WhatsApp.

Practical examples:

  • Automatically sending daily sales reports to a team group.
  • Distributing event photos to all participants in a WhatsApp group.
  • Sharing invoices or receipts with a customer support group.

Properties

Name Type Meaning
Group ID String The unique identifier of the WhatsApp group to which the file will be sent.
Arquivo (Base64) String The content of the file to be sent, encoded in Base64 format.
Nome do Arquivo String The name (including extension) that the file will have when received by the group.
Legenda String A required caption or description that accompanies the file in the group message.

Output

The output is a JSON object containing the response from the OrbitX API after attempting to send the file to the group. While the exact structure depends on the API's response, it typically includes information such as:

{
  "status": "success",
  "messageId": "abc123",
  "groupId": "1234567890@group.whatsapp.com",
  "fileName": "report.pdf",
  "caption": "Monthly Report"
}
  • status: Indicates if the request was successful.
  • messageId: The unique identifier of the sent message.
  • groupId: The ID of the group where the file was sent.
  • fileName: The name of the file sent.
  • caption: The caption/description sent with the file.

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

Dependencies

  • OrbitX API: Requires access to the OrbitX API endpoint.
  • API Credentials: You must configure the orbitxApi credentials in n8n, including:
    • endpointUrl
    • bearerToken
    • secretKey
  • n8n Configuration: Ensure the OrbitX node is installed and properly configured in your n8n instance.

Troubleshooting

Common Issues:

  • Invalid Group ID: If the provided Group ID is incorrect or the bot is not a member of the group, the message will not be delivered.
  • Malformed Base64 Content: If the file content is not valid Base64, the upload will fail.
  • Missing Required Fields: All properties are required; omitting any will result in an error.
  • Authentication Errors: Invalid or expired API credentials will cause authentication failures.

Common Error Messages:

  • "EndpointURL inválida para extrair subdomínio": The endpoint URL in the credentials is malformed. Check your configuration.
  • "Unauthorized" or similar: Your bearer token is invalid or expired. Refresh your credentials.
  • "File upload failed": The Base64 data may be corrupted or too large.

How to resolve:

  • Double-check all input fields, especially the Group ID and Base64 content.
  • Ensure the OrbitX API credentials are correct and up-to-date.
  • Make sure the file size does not exceed any limits imposed by WhatsApp or OrbitX.

Links and References

Discussion