Sign in

v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
Org Level Webhooks

Test webhook

This API sends a test payload to your configured webhook endpoint using a provided event.

This endpoint requires users to provide an event_uuid for a notification event that you have configured a webhook for.

You can find configured notifications event and their uuids by using the List events for Webhook endpoint.

post/webhook/{webhook_uuid}/test

Path parameters

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

The unique identification code (UUID) of the webhook.

Request body

event_uuidstring required

The unique universal identification code of the event that you would like to test for.

Example request

{
  "event_uuid": "fbb4df31-1987-4c27-8eee-764b113e356"
}

Response

Success

event_namestring

The name of the notification event delievered by Ocrolus.

severitystring

The configured importance level for this type of event.

uploaded_docsobject[]
notification_reasonstring

A written explanation of the event that triggered the notification.

notification_typestring

Describes the type of notification the event triggered.

book_uuidstring

A unique identification code (uuid) of the <glossary:Book> from which the event was triggered from.