Sign in
Webhooks

Create a webhook endpoint

Registers a URL to receive webhook events for your agency. The response includes the signingSecret used to verify delivery signatures — it is returned on create only. The first call automatically enables webhooks for the agency. filterTypes is required and must list at least one event type to deliver (see the Webhooks tag for the full list). An agency can have at most 50 endpoints — creating one past that cap returns 422 with the provider's limit message; delete an endpoint to free a slot.

post/api/v1/webhooks/endpoints

Request body

urlstring required

HTTPS URL Atlas delivers events to

descriptionstring

Human-readable label for the endpoint

disabledboolean

Disabled endpoints receive no deliveries

filterTypesstring[] required

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 created

status'ok' required

Changes