Create a webhook endpoint

POST

/v1/webhooks

curl -X POST "https://us1.platform.bird.com/v1/webhooks" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/webhooks/bird",
    "events": [
      "email.delivered",
      "email.bounced"
    ],
    "description": "Production delivery + bounce notifications"
  }'

Registers a new webhook endpoint for the workspace. The signing secret is returned in the response body exactly once — store it immediately. It cannot be retrieved again; use rotate-secret to generate a new one.

Anfrage-Nutzlast

url

string

erforderlich

HTTPS URL to deliver events to.

events

array of string

erforderlich

Concrete event types to subscribe to.

description

string

Human-readable label for this endpoint.

Antwort-Payload

string

erforderlich

url

string

erforderlich

description

string

events

array of string

erforderlich

Concrete event types this endpoint is subscribed to.

status

string

erforderlich

created_at

string

erforderlich

updated_at

string

erforderlich

secret

string

erforderlich

Signing secret (whsec_ prefix). Present in this response only — store it immediately, it cannot be retrieved again.

curl -X POST "https://us1.platform.bird.com/v1/webhooks" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/webhooks/bird",
    "events": [
      "email.delivered",
      "email.bounced"
    ],
    "description": "Production delivery + bounce notifications"
  }'