Webhooks allow you to receive notifications when any event occurs on Olvy. We support the following events in our webhooks:
contact.archive - occurs when a user is deleted
contact.created - occurs when a new user is created
contact.update - occurs when a user is updated
feedback.archive - occurs when feedback is deleted
feedback.created - occurs when new feedback is created
feedback.updated - occurs when feedback is updated
issues.archive - occurs when an issue is archived
issues.create - occurs when an issue is created
issues.update - occurs when an issue is updated
releases.archive - occurs when a release note is deleted
releases.create - occurs when a new release note is created
releases.publish - occurs when a release note is published
releases.update - occurs when a release is updated
Details on what payload each webhook event looks like can be found in the Event Catalog on the webhooks page.
Setup
To set up webhooks, go to the Webhooks section in your workspace settings. The webhooks interface has tabs for Endpoints, Event Catalog, Logs, and Activity.
<aside> 💡 If you don't see the webhooks interface, click on "Get Started" at the top of the screen.
</aside>
To set up a new webhook:
- Go to the Endpoints tab and click on "Add Endpoint".
- The new endpoint form will open up with the following details:
- Endpoint - the URL you want Olvy to send the events to.
- Description - for your reference only, so you can include anything that would help describe what the webhook is for.
- Event Subscriptions - select the list of events you want to be notified on at your endpoint.
- Advanced Configuration - advanced settings for your endpoint. You can enable rate limiting here if your endpoint is rate-limited.
- Click on "Create" to add your endpoint.
- You will then be taken to the endpoint page where you can add custom headers, update the events, or test your endpoint by sending a sample event.
If you need any help integration Olvy webhooks with your systems or integrations please reach out to us on [email protected] and one of our engineers will help you get up and running.