Poli icon

Poli

Node principal para interagir com a API da Poli

Webhook → List Webhooks

AI-generated

Overview

This node operation lists webhooks associated with a specified application in the Poli API. It is useful for retrieving and managing webhooks for an application, allowing users to view details such as status, URL, subscriptions, and metadata. Practical examples include monitoring active webhooks, auditing webhook configurations, or integrating webhook data into workflows.

Use Case Examples

  1. List all webhooks for a given application to monitor their status and URLs.
  2. Search webhooks by specific criteria using the search option to filter results.
  3. Paginate through webhooks using page and perPage options to handle large sets of webhooks.

Properties

Name Meaning
Application UUID The ID of the application to list webhooks from, required to specify which application's webhooks to retrieve.
Options Additional parameters to refine the webhook list, including search text, order, pagination, included fields, and raw query string.

Output

JSON

  • id - Unique identifier of the webhook.
  • url - The URL endpoint of the webhook.
  • status - Current status of the webhook (e.g., active, inactive).
  • subscriptions - List of events or topics the webhook is subscribed to.
  • application - Details of the application associated with the webhook.
  • metadata - Additional metadata related to the webhook.

Dependencies

  • Poli API authentication token or API key credential

Troubleshooting

  • Ensure the Application UUID is correctly provided and valid; missing or incorrect IDs will cause errors.
  • Verify API credentials are correctly configured to avoid authentication errors.
  • Check network connectivity to the Poli API endpoint.
  • If the operation fails, review error messages for details on missing parameters or invalid options.

Links

Discussion