Unipile icon

Unipile

Interact with Unipile API

Overview

This node integrates with the Unipile API, specifically allowing users to create webhooks within the Unipile platform. Creating a webhook enables external systems to receive real-time notifications or data updates from Unipile when certain events occur. This is useful for automating workflows that depend on Unipile events, such as triggering downstream processes, syncing data, or alerting users.

A practical example would be setting up a webhook to notify your application whenever a new message arrives in Unipile, enabling instant processing or logging of that message.

Properties

Name Meaning
Body (JSON) Raw JSON body sent when creating the webhook. This allows customization of the webhook creation request payload.

Output

The node outputs JSON data representing the response from the Unipile API after attempting to create the webhook. This typically includes details about the newly created webhook such as its ID, URL, status, and any other metadata returned by the API.

If the API supports it, binary data output is not indicated in the provided code or properties.

Dependencies

  • Requires an API key credential for authenticating with the Unipile API.
  • The base URL for API requests is dynamically set from the credential's DSN (Data Source Name).
  • The node expects the Unipile API to accept and return JSON-formatted data.

Troubleshooting

  • Invalid or missing API credentials: Ensure the API key or authentication token is correctly configured in the node credentials.
  • Malformed JSON in Body (JSON): If the raw JSON body is invalid, the API request will fail. Validate JSON syntax before execution.
  • API endpoint errors: Check that the base URL (DSN) is correct and the Unipile service is reachable.
  • Permission issues: The API user must have rights to create webhooks; otherwise, the request will be denied.
  • Unexpected API responses: Inspect the returned JSON for error messages or codes to diagnose issues.

Links and References

Discussion