OrbitX icon

OrbitX

Consume OrbitX API
Join our community

Actions17

Overview

The OrbitX node for n8n allows you to interact with the OrbitX API, specifically enabling WhatsApp group messaging automation.
For the resource Mensagem Grupo and operation Enviar Texto (Grupo), this node sends a text message to a specified WhatsApp group.

Common scenarios:

  • Automating notifications or alerts to WhatsApp groups.
  • Sending scheduled updates or reminders to team or customer groups.
  • Integrating group communication into business workflows (e.g., order status updates, event announcements).

Practical example:
You can use this node in an n8n workflow to automatically send a "Daily Standup Reminder" message to your team's WhatsApp group every morning.

Properties

Name Type Meaning
Group ID String The unique identifier of the WhatsApp group where the message will be sent.
Texto String The text content of the message to be delivered to the group.

Output

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

{
  "success": true,
  "messageId": "abc123",
  "status": "sent",
  "to": "group_id_here",
  "body": "Your message text"
}
  • success: Indicates if the message was sent successfully.
  • messageId: Unique identifier for the sent message.
  • status: Status of the message (e.g., "sent").
  • to: The group ID the message was sent to.
  • body: The text of the message sent.

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 following credentials in n8n:
    • endpointUrl (Base URL of the OrbitX API)
    • bearerToken (API authentication token)
    • secretKey (Used as externalKey in requests)

Troubleshooting

Common issues:

  • Invalid Group ID: If the provided Group ID does not exist or is incorrect, the API may return an error indicating the group was not found.
  • Authentication Errors: If the bearer token is missing or invalid, you may receive a 401 Unauthorized error.
  • Missing Required Fields: If either "Group ID" or "Texto" is empty, the node will fail to execute.

Error messages and resolutions:

  • "EndpointURL inválida para extrair subdomínio": Check that your endpointUrl credential is correctly formatted (should start with https://).
  • 401 Unauthorized: Verify your API credentials (bearerToken, endpointUrl) are correct and have not expired.
  • 400 Bad Request: Ensure all required properties ("Group ID", "Texto") are provided and valid.

Links and References

Discussion