---
title: "Update webhook"
method: PATCH
path: "/platform/v2beta/webhooks/{id}"
tags: ["Webhooks"]
---

# Update webhook

`PATCH /platform/v2beta/webhooks/{id}`

## Request

- Base URL: `https://api.atlar.com`
- URL: `https://api.atlar.com/platform/v2beta/webhooks/{id}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/atlar/apis/atlar-api-v2/docs/platform/v2beta/webhooks/:id/patch.ts> (a function with typed inputs; its response is checked against the schema)

Update webhook configuration. Modifying `/url` sets `verified` to
false. You can contact
[support@atlar.com](mailto:support@atlar.com) to get a webhook
configuration verified. Changes may take up to 10 minutes until
they are in full effect.

If the webhook was created via API v1, it can't be patched;
replace it with a new one using `POST /v2beta/webhooks` instead.
The new webhook starts unverified, and has no signing key until
you create one with `POST /v2beta/webhooks/{id}/keys`.

## Path parameters

- `id` string, required

## Request body

- union[]: JSON Patch request to update a webhook.
  - union
    - WebhookJSONPatchReplaceUrl: Change webhook URL. Modifying the URL makes the webhook unverified (`verified: false`).
      - `op` 'replace', required
      - `path` '/url', required
      - `value` string, required: The URL to which webhooks will be sent via HTTP POST requests in JSON format. Must use scheme `https://`.
    - WebhookJSONPatchReplaceFilters: Change webhook filters. Like /url and /alias, this doesn't work if the webhook was created via API v1.
      - `op` 'replace', required
      - `path` '/filters', required
      - `value` CreateWebhookFilter[], required
        - `resource` string, required: The API resource for which to receive webhooks. See available resources in the [Webhooks and events](doc:api#webhooks-and-events) section.
        - `eventTypes` EventType[], required: A list of event types for which to receive webhooks.
    - WebhookJSONPatchReplaceAlias: Change the webhook alias. Use an empty string to clear the alias.
      - `op` 'replace', required
      - `path` '/alias', required
      - `value` string, required

## Response `200`

The updated webhook.

- Webhook: A webhook configuration.
  - `id` string, required: Unique resource identifier.
  - `organizationId` string, required: Unique resource identifier for an Organization.
  - `url` string, required: The URL to which webhooks will be sent via HTTP POST requests in JSON format. Must use scheme `https://`.
  - `filters` WebhookFilter[], required: An inclusive filter to specify which resources and events that you are interested in.
    - `resource` string, required: The API resource for which to receive webhooks. See available resources in the [Webhooks and events](doc:api#webhooks-and-events) section.
    - `eventTypes` EventType[], required: A list of event types for which to receive webhooks.
    - `apiVersion` integer, required: The API version to serialize resources as. E.g. if you are consuming events and do want to deserialize into `/payments/v2/credit-transfers`, set `apiVersion: 2`.
    - `legacyEventNames` string[]: API v1 event names. This is only for backwards compatibility with webhooks created via API v1.
  - `verified` boolean, required: Webhooks requests won't be sent if the webhook configuration is not verified (by Atlar). Modifying the URL sets verified to false. You can contact [support@atlar.com](mailto:support@atlar.com) to get a webhook configuration verified.
  - `alias` string: A human-readable name for the webhook.
  - `created` string, date-time, required: Time at which the resource was created.
  - `updated` string, date-time, required: Time at which the resource was last updated.

## Other responses

- `400`: Bad request.
- `404`: Resource not found.
- `412`: Precondition failed.

## Changes

- **2026-11-03** `b49df1e4b3e9`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/atlar/apis/atlar-api-v2/changes/platform/v2beta/webhooks/:id/patch.md)

---

[API](https://skmtc.dev/atlar/apis/atlar-api-v2.md) - [All operations](https://skmtc.dev/atlar/apis/atlar-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/atlar/apis/atlar-api-v2/revisions/b49df1e4b3e9?raw)