ANanchorbrowser
Webhooks

Create Webhook

Changed on

Register a new HTTPS endpoint to receive events. The response includes a one-time secret (HMAC-SHA256 signing key) — store it; Anchor never returns it again. Up to 5 webhooks per project.

post/v1/webhooks

Request

  • Base URL
    https://api.anchorbrowser.io
  • Auth
    API key in header anchor-api-key

Request body

urlstring uri required

HTTPS endpoint Anchor will POST events to. Rejected (400) if it points at loopback / private / link-local IPs, cloud metadata services, internal-only TLDs, AWS STS / IAM / EKS endpoints, or contains basic-auth credentials.

descriptionstring

Optional human-readable description.

subscribed_eventsWebhookEventType[] required

Events this webhook should receive. At least one is required.

Example request

{
  "url": "https://your-app.example.com/anchor/webhooks",
  "description": "Production task notifications"
}

Response

Webhook created. The secret field is returned ONCE — copy it now.

idstring required

Webhook id. Use as the path parameter on subsequent calls.

project_idstring uuid required

The project (team) the webhook belongs to.

urlstring uri required

HTTPS URL Anchor will POST events to.

descriptionstring nullable required

Optional human-readable description.

subscribed_eventsWebhookEventType[] required

Event types this webhook is currently subscribed to.

enabledboolean required

When false, no events fan out to this webhook.

created_atstring date-time nullable required
updated_atstring date-time nullable required
secretstring required

HMAC-SHA256 signing secret. Use this to verify the Anchor-Signature header on each delivery.

Example response

{
  "id": "wh_01HXJ4MZ7K9P3Q6R8S2T4V5W7Y",
  "project_id": "5d2c31f6-ab7e-481a-b6fd-8b4a96a4e197",
  "url": "https://your-app.example.com/anchor/webhooks",
  "description": "Production task notifications",
  "enabled": true,
  "secret": "36da51b166a69268a59a8d5ee0b32c9f5e5aaee7d301c7a5a36844318e116fc6"
}

Changes