Sign in
Webhooks

Update a webhook endpoint

Updates a webhook endpoint with PATCH semantics — only the provided fields change. A filterTypes array replaces the current event types and must list at least one.

patch/api/v1/webhooks/endpoints/{id}

Path parameters

idstring required

Webhook endpoint ID

Example:ep_2mKQd8N7Yq3XwGvchvYcaXgVYFa

Request body

urlstring

HTTPS URL Atlas delivers events to

descriptionstring

Human-readable label for the endpoint

disabledboolean

Disabled endpoints receive no deliveries

filterTypesstring[]

Event types to deliver to this endpoint. At least one is required

Example request

{
  "url": "https://example.com/webhooks/atlas",
  "filterTypes": [
    "person.created",
    "placement.created"
  ]
}

Response

Webhook endpoint updated

status'ok' required

Changes

Changed in 2 of the 8 revisions of this API.2