---
title: "Configure webhook"
method: POST
path: "/v1/account/settings/update/webhook_endpoint"
tags: ["Webhooks"]
---

# Configure webhook

`POST /v1/account/settings/update/webhook_endpoint`

Set up a webhook for your account so your application can react to Ocrolus events.

---
You can find a list of supported account-level event types and their sample notifications in the [Account-level webhook guide](https://docs.ocrolus.com/ocrolus-api/docs/account-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.

> 🚧 We have a better version!
> This product is superseded by [Org Level Webhooks](https://docs.ocrolus.com/ocrolus-api/docs/organization-level-webhook), which we recommend for improved functionality and integration.

## Response `200`

Success

- object
  - `status` integer, required — Numerical code indicating the status of this request. Will be 200 for a successful response.
  - `code` integer — Numerical code indicating the nature of an error. Will not be present if the response is successful.
  - `message` string, required — A textual description that indicates details about this response's status. Will be "OK" for a successful request.
  - `response` WebhookRegistration, required — An object that describes the active webhook registration. Only one webhook can be registered at this time; if you need multiple event handlers, your implementation should inspect the request payload and direct events as needed.
    - `webhook_endpoint` string, url, required — The value of `webhook_endpoint` that was provided in the request. Can contain query parameters, port numbers, authentication credentials, and other URL components.
    - `events` WebhookEventType[], required — The webhook events that were successfully registered. Invalid event names will not be included here.

## Other responses

- `400` — Client Errors

---

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