A webhook enables Ovoko to push real-time notifications to your app.
Ovoko uses HTTPS to send these notifications to your app as a JSON payload.
You can then use these notifications to execute actions in your backend systems.
- Identify the events you want to monitor and the event payloads to parse.
- Create a webhook endpoint as an HTTP endpoint (URL).
- Handle requests from Ovoko by parsing each event
object and returning
2xx
response status codes.
- Secure your webhooks.
- Provide your publicly accessible HTTPS URL to us.
Creating a webhook endpoint is no different from creating any other page on your website.
It’s an HTTP or HTTPS endpoint on your server with a publicly accessible URL.
You have to use one endpoint to handle several different event types at once.
Use the
Events
reference guide to identify the Ovoko events and their event objects your webhook endpoint needs to parse.
Set up an HTTP endpoint that can accept webhook requests with a POST method.
Your endpoint must be configured to read event objects for the type of event notifications you want to receive.
Ovoko sends events to your webhook endpoint as part of a POST request with a JSON payload.
Use header token authorization to verify that webhook request came from Ovoko.
Register your publicly accessible HTTPS URL by contacting api@ovoko.com