Actions148
- Chats Actions
- Chat Contacts Actions
- Chat Messages Actions
- Chat Files Actions
- Files Actions
- Team Actions
- Labels Actions
- Departments Actions
- Quick replies Actions
- Queue Actions
- WhatsApp session Actions
- WhatsApp profile Actions
- Business catalog Actions
- Campaigns Actions
- Meeting Links Actions
- User Status Actions
- Webhooks Actions
- Other Actions
- Send messages Actions
- Outbound Messages Actions
- WhatsApp Numbers Actions
- Groups Actions
- Channels Actions
Overview
This node interacts with the SparkBot WhatsApp API, specifically allowing users to manage and retrieve information about webhooks configured in their SparkBot environment. The Get Webhooks operation under the Webhooks resource fetches a list of webhooks filtered by various criteria such as device IDs, status, search terms, pagination size, and page number.
Typical use cases include:
- Retrieving active or disabled webhooks for monitoring or auditing purposes.
- Filtering webhooks associated with specific devices.
- Searching webhooks by text to find particular webhook configurations.
- Paginating through large sets of webhooks to process or display them incrementally.
For example, a user might want to get all active webhooks related to certain devices to verify their status or update their configuration accordingly.
Properties
| Name | Meaning |
|---|---|
| Filters | A collection of filters to narrow down the webhooks retrieved: |
| - Device IDs | Select one or multiple device IDs to filter webhooks associated with those devices. |
| - Status | Filter webhooks by their status. Options: Active, Disabled, Pending. |
| - Search Term | Text string to search webhooks by matching text fields. |
| - Results Page Size | Number specifying how many results to return per page (default 20). |
| - Page Number | Number specifying which page of results to retrieve, starting from 0 (default 0). |
Output
The output is an array of JSON objects representing the webhooks that match the specified filters. Each object contains details about a webhook, such as its ID, associated device, status, and other relevant metadata provided by the SparkBot API.
If the node supports binary data output (not explicitly shown here), it would typically represent files or media related to webhooks, but this operation primarily returns JSON data describing webhook configurations.
Dependencies
- Requires an API key credential for authenticating with the SparkBot WhatsApp API.
- The node depends on the SparkBot API service being accessible and properly configured.
- Pagination and filtering rely on the API's support for these query parameters.
Troubleshooting
Common issues:
- Invalid or missing API key credential will cause authentication failures.
- Using invalid device IDs or statuses in filters may result in empty responses.
- Requesting pages beyond the available range will return empty results.
- Network connectivity issues can prevent successful API calls.
Error messages:
- Authentication errors usually indicate problems with the API key; ensure it is valid and has necessary permissions.
- Validation errors may occur if filter values are malformed; double-check input types and allowed options.
- Rate limiting or server errors from the API should be handled by retrying after some delay.
Links and References
- SparkBot WhatsApp API Documentation (example placeholder link)
- n8n documentation on Creating Custom Nodes
- General info on Webhook Concepts
Note: This summary is based solely on static analysis of the provided source code and property definitions.