OrbitXInstall

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 Arquivo, this node enables sending a file (as a Base64-encoded attachment) to a specific WhatsApp number, along with a required caption.

Common scenarios:

• Automating the delivery of documents, images, or other files to customers via WhatsApp.
• Sending invoices, receipts, or reports as attachments in customer support workflows.
• Sharing multimedia content programmatically with individual users.

Example use case:
A business wants to automatically send a PDF invoice to a customer’s WhatsApp number after a purchase is completed.

---

Properties

Name	Type	Meaning
Número (E.164)	String	The recipient's WhatsApp phone number in E.164 format (e.g., +5511999998888).
Arquivo (Base64)	String	The file content encoded in Base64.
Nome do Arquivo	String	The filename (including extension) that will be shown 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 the output depends on the API response, but typically includes information such as message status, IDs, and any error messages if applicable.

Example output (structure may vary):

[
  {
    "status": "success",
    "messageId": "abc123",
    "to": "+5511999998888",
    "fileName": "invoice.pdf",
    "caption": "Segue sua nota fiscal."
  }
]

Note: The actual fields depend on the OrbitX API implementation.

---

Dependencies

• OrbitX API credentials are required:
  • endpointUrl: The base URL for the OrbitX API.
  • bearerToken: Used for authentication.
  • secretKey: Used as an external key in requests.
• The node must be configured with valid OrbitX API credentials in n8n.

---

Troubleshooting

Common issues:

• Invalid phone number format: Ensure the number is in E.164 format (e.g., +5511999998888).
• Missing or invalid Base64 data: The file must be properly Base64-encoded.
• Empty or missing caption: The "Legenda" field is mandatory.
• Authentication errors: Check that your OrbitX API credentials are correct and active.
• File size limits: Large files may be rejected by the API; check OrbitX documentation for limits.

Error messages:

• "EndpointURL inválida para extrair subdomínio": The endpoint URL provided in credentials is not valid. Double-check the URL format.
• API error responses: If the API returns an error, it will be included in the node's output. Review the message for details.

---

Links and References

• E.164 Phone Number Format
• For more details, consult your OrbitX API documentation or support resources.