Actions22
- App Actions
- Account Actions
- Channel Actions
- Message Actions
- Template Actions
- Contact Actions
- Tag Actions
- User Actions
- Team Actions
- Webhook Actions
Overview
The node provides integration with the Poli API, specifically allowing users to list webhooks associated with a given application. This operation is useful for managing and monitoring webhook configurations within an application, such as retrieving all registered webhooks, filtering them by various criteria, or paginating through large sets of webhooks.
Practical scenarios include:
- Auditing all webhooks configured for an application.
- Searching for specific webhooks by name or other attributes.
- Paginating through webhooks when there are many registered.
- Including additional related data like status, URL, subscriptions, or metadata in the output.
Properties
| Name | Meaning |
|---|---|
| Application ID | The ID of the application from which to list webhooks. |
| Options | Additional optional parameters to refine the listing: |
| - Search | A search string to filter webhooks by matching text. |
| - Order | The order in which to sort the results (e.g., ascending or descending). |
| - Page | The page number to retrieve (for pagination). |
| - Per Page | Number of webhooks to return per page. |
| - Include | Related data to include with each webhook. Possible values: Status, URL, Subscriptions, Application, Metadata. |
| - Query | Raw query string for advanced filtering (e.g., id=18&name=gabriel). |
Output
The node outputs JSON data representing the list of webhooks retrieved from the Poli API. Each webhook object may contain standard webhook properties such as its ID, name, and depending on the "Include" options selected, additional fields like status, URL, subscription details, application info, and metadata.
If binary data were involved (not indicated here), it would typically represent files or attachments related to the webhook, but this node focuses on JSON data only.
Dependencies
- Requires an API key credential for authenticating with the Poli API.
- The node depends on the Poli API service being accessible and properly configured.
- No additional environment variables are explicitly required beyond the API authentication.
Troubleshooting
Common issues:
- Invalid or missing Application ID will cause the API call to fail.
- Incorrect API credentials or expired tokens will result in authentication errors.
- Using unsupported or malformed query strings in the "Query" option can lead to API errors.
- Pagination parameters out of range may return empty results or errors.
Error messages:
"Resource 'webhook' not found": Indicates the resource parameter was incorrect or missing."Operation 'list' not found for resource 'webhook'": Means the operation parameter is invalid.- API authentication errors usually indicate problems with the provided API key.
Resolutions:
- Verify that the Application ID is correct and exists in the Poli system.
- Ensure the API key credential is valid and has necessary permissions.
- Double-check query syntax and pagination parameters.
- Review API documentation for allowed values in "Order" and "Include" options.
Links and References
- Poli API Documentation (general reference): https://docs.poliapi.com (example placeholder, replace with actual if known)
- n8n Documentation on creating custom nodes: https://docs.n8n.io/integrations/creating-nodes/