v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB

Org Level Webhooks

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.

post/webhook

Request body

event_namesstring[]

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.

Example request

{
  "webhook": {
    "description": "Trigger when a document failed in verification.",
    "url": "https://www.ocrolus.com/",
    "uuid": "9be5c090-7dd6-465b-950e-885b95e1863a",
    "is_active": true,
    "created_on": "2022-10-03T09:41:38.000Z",
    "last_modified_date": "2022-10-03T09:41:38.000Z"
  }
}

Response

statusstring

The success response status received from the server.

messagestring

The success message received from the server corresponding to the response status.

Example response

{
  "status": "200",
  "message": "OK",
  "response": {
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}