---
title: "Test webhook"
method: POST
path: "/webhook/{webhook_uuid}/test"
tags: ["Org Level Webhooks"]
---

# Test webhook

`POST /webhook/{webhook_uuid}/test`

## Request

- Base URL: `https://api.ocrolus.com/v1/account/settings`
- URL: `https://api.ocrolus.com/v1/account/settings/webhook/{webhook_uuid}/test`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://auth.ocrolus.com/oauth/token`

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](ref:list-events).

## Path parameters

- `webhook_uuid` string, uuid, required

## Request body

- object
  - `event_uuid` string, required: The unique universal identification code of the event that you would like to test for.

## Response `200`

Success

- object
  - `event_name` string: The name of the notification event delievered by Ocrolus.
  - `severity` string: The configured importance level for this type of event.
  - `uploaded_docs` object[]
  - `notification_reason` string: A written explanation of the event that triggered the notification.
  - `notification_type` string: Describes the type of notification the event triggered.
  - `book_uuid` string: A unique identification code (uuid) of the <<glossary:Book>> from which the event was triggered from.

---

[API](https://skmtc.dev/ocrolus/apis/org-level-webhooks.md) - [All operations](https://skmtc.dev/ocrolus/apis/org-level-webhooks/llms.txt) - [OpenAPI document](https://skmtc.dev/ocrolus/apis/org-level-webhooks/revisions/ef603756da38?raw)