Sendtick icon

Sendtick

Interact with Sendtick API for WhatsApp messaging
Join our community

Actions5

Overview

This node integrates with the Sendtick API to manage WhatsApp contacts, messages, and sessions. Specifically, for the Contact - Get Many operation, it retrieves multiple contact records from the Sendtick service based on various filters and pagination options.

Common scenarios where this node is beneficial include:

  • Fetching a list of WhatsApp contacts filtered by search criteria such as name, email, phone, tag, or group.
  • Retrieving all contacts or a limited subset for processing in workflows like marketing campaigns, customer support, or analytics.
  • Paginating through large contact lists to handle data in manageable chunks.

Practical example:

  • A user wants to get all contacts tagged as "VIP" to send them a special promotion message.
  • Another use case is searching contacts by partial name or phone number to find specific customers quickly.

Properties

Name Meaning
Return All Whether to return all matching contacts or limit the results to a specified maximum count.
Search Query Text query to search contacts by name, email, or phone.
Tag Filter contacts that have a specific tag assigned.
Group ID Filter contacts belonging to a particular group identified by its ID.
Offset Pagination offset to skip a number of contacts before starting to return results.
Limit Maximum number of contacts to return when not returning all (only applicable if Return All is false).

Output

The output is an array of JSON objects representing the retrieved contacts. Each object corresponds to a contact record returned by the Sendtick API's /contacts endpoint. The exact structure depends on the API response but typically includes fields like contact ID, name, phone number, tags, groups, and other metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Sendtick API.
  • The node uses the base URL https://sendtick.co/api/v1.
  • Proper configuration of the Sendtick API credentials within n8n is necessary for successful execution.

Troubleshooting

  • Empty results: If no contacts are returned, verify that the search query, tag, or group ID filters are correct and that contacts exist matching those criteria.
  • Authentication errors: Ensure the API key credential is valid and has the required permissions.
  • Pagination issues: When using offset and limit, ensure values are within valid ranges; otherwise, the API may return unexpected results or errors.
  • API rate limits: Excessive requests might be throttled by the Sendtick API; consider adding delays or handling retries.
  • Error messages: The node throws errors if unsupported resource/operation combinations are used or if required parameters are missing.

Links and References

Discussion