Sign in

v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
Org Level Webhooks

Update webhook

This API updates the settings for a webhook in your organization by using the webhook's universally unique identification code (UUID).

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

post/webhook/{webhook_uuid}/update

Path parameters

webhook_uuidstring uuid required
Example:9be5c090-7dd6-465b-950e-885b95e1863a

The unique identification code (UUID) of the 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.

The event list given in this parameter will replace all existing subscriptions, i.e. providing a single event will subscribe only to that event while unsubscribing from the others.

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

OK

statusstring

The success response status received from the server.

messagestring

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

responseobject nullable

Example response

{
  "status": "200",
  "message": "OK"
}