FlagdeckFlagdeck
Pricing
Docs
Get Started

Documentation

Webhooks

Webhooks live under a project and notify your endpoint when entities change. All endpoints require webhooks:read or webhooks:write.

List webhooks

GET /v1/projects/{projectId}/webhooks (scope: webhooks:read)

Get a webhook

GET /v1/projects/{projectId}/webhooks/{webhookId} (scope: webhooks:read)

Create a webhook

POST /v1/projects/{projectId}/webhooks (scope: webhooks:write)

FieldTypeRequired
namestringyes
urlstring (https)yes
eventsstring[]yes

bash

curl -X POST https://api.flagdeck.com/v1/projects/PROJECT_ID/webhooks \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Ops", "url": "https://example.com/hook", "events": ["flag.updated"] }'

Update a webhook

PATCH /v1/projects/{projectId}/webhooks/{webhookId} (scope: webhooks:write)

Toggle a webhook

POST /v1/projects/{projectId}/webhooks/{webhookId}/toggle (scope: webhooks:write)

Send a test event

POST /v1/projects/{projectId}/webhooks/{webhookId}/test (scope: webhooks:write)

Delete a webhook

DELETE /v1/projects/{projectId}/webhooks/{webhookId} (scope: webhooks:write)