Zappfy API icon

Zappfy API

Interact with Zappfy API
Join our community

Actions48

Overview

This node integrates with the Zappfy API to send documents as messages through a specified messaging instance. It is useful for automating the distribution of files such as PDFs, images, or other document types directly to recipients via their messaging IDs. Typical use cases include sending invoices, contracts, reports, or any important documents automatically from workflows.

For example, you can configure this node to send a PDF invoice to a customer’s WhatsApp number immediately after an order is processed, including an optional caption message and mentions if used in group chats.

Properties

Name Meaning
Nome Da Instância The name of the messaging instance that will send the document.
Número Do Destinatário The recipient's messaging ID (e.g., phone number with country code).
Documento The document to send, provided as a URL or base64 string.
Mensagem Optional text message to accompany the document.
Nome Do Arquivo The filename to assign to the sent document (default: "document.pdf").
Opções Additional options for sending the message:
- Delay Time in milliseconds to wait before sending the message (default 1200 ms).
- Responder Mensagem Option to reply to a specific message by providing its message ID.
- Menções Settings to mention participants in a group chat:
-- Mencionar Todos Boolean to mention all participants.
-- Números Para Mencionar Comma-separated list of numbers to mention individually (only if not mentioning everyone).

Output

The node outputs a JSON array containing the response from the Zappfy API after attempting to send the document message. This typically includes confirmation details such as message IDs, status, timestamps, or error information if the operation failed.

No binary data output is indicated by the source code or properties.

Dependencies

  • Requires an active connection to the Zappfy API.
  • Needs an API authentication token configured in n8n credentials (referred generically as an API key credential).
  • Internet access to reach the Zappfy API endpoint at https://docs.zappfy.io/api-reference.

Troubleshooting

  • Common issues:

    • Invalid or missing instance name or recipient ID may cause the API call to fail.
    • Incorrect document URL or malformed base64 string can prevent the document from being sent.
    • Insufficient permissions or invalid API credentials will result in authentication errors.
    • Delay values too low might cause rate limiting or message ordering issues.

  • Error messages:

    • "Operação não suportada." indicates the requested operation is not implemented for the selected resource; verify correct resource and operation names.
    • API errors returned from Zappfy will be passed through; check the error message for details like invalid parameters or quota exceeded.

  • Resolutions:

    • Double-check all required fields are correctly filled.
    • Validate the document input format and accessibility.
    • Ensure the API key credential is valid and has necessary permissions.
    • Adjust delay settings if encountering rate limits.

Links and References

Discussion