Skip to main content
POST
Register a webhook endpoint

Authorizations

Authorization
string
header
required

Headers

X-Workspace-Id
string<uuid>
required

UUID of the workspace to act in. Take it from GET /me (workspaces[].id). A key scoped to specific workspaces is rejected with 403 WORKSPACE_NOT_ALLOWED for any other id; a missing header is 400 WORKSPACE_REQUIRED.

Body

application/json
url
string<uri>
required
events
enum<string>[]
required
Minimum array length: 1

Event names a new subscription may name. scan.completed, evaluation.completed and page.reviewed still deliver to existing subscriptions but are rejected with 422 VALIDATION_ERROR on POST /webhooks.

Available options:
run.completed,
run.item.completed,
page.created,
page.ready,
page.needs_changes,
page.published,
page.unpublished,
page.archived,
tracking.run.completed,
article.created,
article.ready,
article.needs_changes,
article.published,
article.unpublished,
article.archived,
brief.run.completed,
brief.run.item.completed,
tracking_run.completed

Response

Webhook registered

data
object
required