v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB

Org Level Webhooks

Retrieve webhook

This API retrieves a specific webhook using its 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.

get/webhook/{webhook_uuid}

Path parameters

webhook_uuidstring uuid required

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

The unique identification code (UUID) of the webhook.

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": {
    "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"
  }
}