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

# Update webhook

`POST /webhook/{webhook_uuid}/update`

## Request

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

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](doc:organization-level-webhook#available-events).

## Path parameters

- `webhook_uuid` string, uuid, required

## Request body

- WebhookUuidUpdateBody
  - `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](doc:organization-level-webhook#available-events) 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.

## Response `200`

OK

- InlineResponse2003
  - `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` object, nullable

## Other responses

- `400`: Webhook not updated

---

[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)