---
title: "Add webhook"
method: POST
path: "/webhook"
tags: ["Org Level Webhooks"]
---

# Add webhook

`POST /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](https://docs.ocrolus.com/ocrolus-api/docs/organization-level-webhook#available-events).

> 📘
> Your webhook integration should respond to incoming notifications with a status of `200 OK` to indicate that it's working properly.

## Request body

- WebhookBody
  - `webhook` Webhook
    - `description` string — A brief description of the webhook. A description is not required but if provided, a minimum of 3 characters is required with a maximum length of 255.
    - `url` string — A unique resource locator (URL) of the webhook. Ocrolus will attempt to send a notification to this URL to notify about any configured events.
    - `uuid` string, uuid — The universally unique identification code (UUID) of the webhook.
    - `is_active` boolean — Determines if notificiations will be sent to the provided webhook.
    - `created_on` string — The timestamp at which the webhook is created.
    - `last_modified_date` string — The timestamp at which the webhook was last modified.
  - `event_names` string[] — 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](https://docs.ocrolus.com/ocrolus-api/docs/organization-level-webhook#available-events) for a list of all possible events.

## Response `200`

OK

- InlineResponse2004
  - `status` string — The success response status received from the server.
  - `message` string — The success message received from the server corresponding to the response status.
  - `response` InlineResponse2004Response
    - `uuid` string, uuid — The universally unique identification code (UUID) of the webhook.

## Other responses

- `400` — Webhook not created

---

[API](https://skmtc.net/ocrolus/apis/user-management.md) · [All operations](https://skmtc.net/ocrolus/apis/user-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ocrolus/user-management/versions/3571ef602d13/schema)