Webhooks are notifications sent from Klipy to your other tool whenever a certain event occurs.
As soon as an event occurs (such as lead or interaction being captured by Klipy), a notification with the data is immediately sent to the webhook URL which is set in the configuration panel.
Available events
Lead captured
Interaction captured
You can also find a full list of all the events Klipy support:
In Klipy settings, navigate to the Webhooks page.
Select the Event Catalog tab.
Let us know if you have any other events in mind!
Disclaimer
Klipy uses Svix to send our webhooks.
Klipy webhook notifications are sent via a POST request, while the request body (with response data) is in JSON format.
This feature is designed for advanced users with knowledge of how webhooks and HTTP communications work.
Our team does not have access to your data and code and hence cannot troubleshoot your code or provide step-by-step development instructions.
Set up your Webhooks
In Klipy settings, navigate to the Webhooks page.
Click Add Endpoint to make a new connection
Enter a destination URL. This is where the HTTP POST requests will be sent to.
Select the event types you want to send notifications for.
Click Create after all fields are done, and you should be able to see it added to the list where you can add new webhooks or manage existing ones.
Testing and payload structure
The payload of a webhook is a JSON object that contains the following properties:
data: contains the actual payload sent by Klipy. The payload can be different object depending on theeventtype.object: always set toeventtype: the type of event that triggered the webhook.
You can also find a full list of all the events and their payload examples:
In Klipy settings, navigate to the Webhooks page.
Select the Event Catalog tab.
Testing
You can test webhooks using Svix Play. Or simply click with Svix Play inside endpoint creation page. Once set up, you can see all the live notifications in Svix Play dashboard.
How Klipy handles delivery issues
Retry
Svix will use a set schedule and retry any webhooks that fail. To see up-to-date schedule, see the Svix Retry Schedule.
If Svix is attempting and failing to send a webhook, and that endpoint is removed or disabled from the Webhooks page in Klipy settings, then the attemps will also be disabled.
Replay
If a webhook message fails to send, you have the option to replay the webhook messages. This protects against your other systems having downtime or against a misconfigured endpoint.
To reply webhook messages:
In Klipy settings, navigate to the Webhooks page.
Select the affected endpoint.
In the Message Attempts section, next to the message you want to replay, select the menu icon on the right side, and then select Replay.
The Replay Messages menu will appear. You can choose to:
Resend the specific message you selected.
Resend all failed messages since the first failed message in that date range.
Resend all missing messages since the first failed message in that date range.