Zappfy API icon

Zappfy API

Interact with Zappfy API

Overview

The node "Zappfy API" provides integration with the Zappfy service, allowing users to interact programmatically with its API. Specifically, for the Resource "Grupo" and Operation "Encontrar Participantes," this node fetches the list of participants in a specified group. This is useful in scenarios where you need to automate management or monitoring of group members, such as syncing participant data, auditing group membership, or triggering workflows based on group composition.

For example, you might use this node to retrieve all members of a WhatsApp group (via Zappfy) to send targeted messages or analyze participation trends.

Properties

Name Meaning
Nome Da Instância The name of the Zappfy instance to connect to. This identifies which environment or account to query.
ID Do Grupo The unique identifier of the group whose participants you want to find.

Output

The node outputs a JSON array where each element represents a participant found in the specified group. Each participant object typically contains details such as participant identifiers and possibly metadata related to their membership.

If the node supports binary data output, it would relate to any media or files associated with participants, but based on the provided code and operation, the output is primarily JSON data listing participants.

Dependencies

  • Requires an active connection to the Zappfy API.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The base URL for API requests is set to https://docs.zappfy.io/api-reference (likely a placeholder or documentation URL; actual API endpoint may differ).

Troubleshooting

  • Operation Not Supported Error: If you receive an error stating the operation is not supported, verify that the resource and operation names are correctly set to "groups-api" and "find-participants" respectively.
  • Authentication Issues: Ensure the API key or authentication token is valid and has sufficient permissions to access group participant data.
  • Empty Participant List: If no participants are returned, confirm the group ID is correct and that the group actually has members.
  • Network or API Endpoint Errors: Check network connectivity and verify the API base URL is correctly configured in the node settings.

Links and References

Discussion