Zappfy API icon

Zappfy API

Interact with Zappfy API
Join our community

Actions48

Overview

The node "Zappfy API" provides integration with the Zappfy service, allowing users to interact programmatically with its API. Specifically, for the Chat resource and the Listar Contatos (List Contacts) operation, the node retrieves contact information from a specified instance of the Zappfy platform.

This node is useful in scenarios where you want to automate the retrieval of contacts from a chat system, such as syncing contacts into a CRM, performing bulk messaging, or managing contact lists dynamically within an automation workflow.

For example, you can:

  • List all contacts from a given chat instance.
  • Retrieve details of a specific contact by providing their unique identifier.

Properties

Name Meaning
Nome Da Instância The name of the Zappfy instance from which to retrieve contacts.
Listar Todos Boolean option to list all contacts (true) or not (false).
Contato The specific contact's unique identifier (number) to retrieve when not listing all.

Output

The node outputs an array of JSON objects representing the contacts retrieved from the Zappfy API. Each object corresponds to a contact and contains relevant contact details as provided by the API.

If binary data were involved (e.g., profile pictures), it would be included in the output's binary property, but based on the code and properties, this node focuses on JSON contact data only.

Dependencies

  • Requires an active connection to the Zappfy API via an API key credential configured in n8n.
  • The node uses the base URL https://docs.zappfy.io/api-reference for API requests.
  • Proper authentication credentials must be set up in n8n to authorize API calls.

Troubleshooting

  • Operation Not Supported Error: If you select an unsupported operation or resource, the node throws an error indicating the operation is not supported. Ensure that the resource is "chat-api" and the operation is "find-contacts" (Listar Contatos).
  • Missing Required Parameters: The node requires the instance name and either the "list all" flag or a specific contact ID. Omitting these will likely cause errors or empty results.
  • API Authentication Issues: If the API key or credentials are invalid or missing, the node will fail to connect. Verify your API credentials in n8n settings.
  • Empty Results: If no contacts are returned, verify that the instance name is correct and that the account has contacts available.

Links and References

Discussion