Add webhook

Set up an org-level webhook for your organization so your application can receive and respond to Ocrolus events in real time. Use this endpoint to create or update the webhook configuration. Ocrolus then delivers event payloads to your application as they occur, allowing you to automate downstream workflows.


You can find a list of supported org-level event types and their sample notifications in the Org-level webhook guide.

📘

Your webhook integration should respond to incoming notifications with a status of 200 OK to indicate that it's working properly.

Body Params

Create a new webhook

webhook
object

An object containing information about the webhook you are configuring for.

event_names
array of strings
length ≥ 1

An array of events that will trigger a call to your webhook. Atleast one event is required per request. Please see our guide on Org level webhooks for a list of all possible events.

event_names
Responses

Language
Credentials
OAuth2
Response
Choose an example:
application/json