Unipile icon

Unipile

Interact with Unipile API

Overview

This node integrates with the Unipile API to manage webhooks. Specifically, the "List Webhooks" operation retrieves a list of existing webhooks configured in the Unipile system. This is useful for scenarios where you want to programmatically view or audit all webhooks currently set up, such as monitoring integrations, debugging event flows, or synchronizing webhook configurations.

Practical examples include:

  • Fetching all webhooks to display them in a dashboard.
  • Automating checks to ensure required webhooks are active.
  • Retrieving webhook details before updating or deleting them.

Properties

Name Meaning
Additional Fields Optional parameters to customize the listing:
- Cursor A pagination cursor string to fetch the next page of results.
- Limit Maximum number of webhook results to return (minimum 1, default 50).

Output

The node outputs JSON data containing an array of webhook objects retrieved from the Unipile API. Each webhook object typically includes details such as its ID, URL, events it listens to, and status. The exact structure depends on the Unipile API response but generally provides comprehensive information about each webhook.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Unipile API.
  • The base URL for API requests is configured via the credential's DSN (Data Source Name).
  • The node sends HTTP requests with JSON content type headers.

Troubleshooting

  • Empty or incomplete webhook list: Ensure that the API key has sufficient permissions to read webhook data.
  • Pagination issues: If not all webhooks appear, use the Cursor property to paginate through results.
  • Invalid limit values: The Limit must be at least 1; setting it lower may cause errors.
  • Authentication errors: Verify that the API key credential is valid and correctly configured.
  • Network or API errors: Check connectivity and Unipile API status if requests fail.

Links and References

Discussion