Skip to main content
POST
Create a webhook endpoint
Creates an endpoint for the team. The signing secret is returned once, in this response only. Store it to verify signatures. A team can have at most 10 endpoints. Integration webhooks require an active Business, Agency Business or Enterprise plan. Changing an endpoint also requires an API token with write access enabled by an Owner or Manager. See Integration webhooks and Writing data.
string
required
Bearer token for your team.
string
required
Unique key for this operation, at most 255 characters. Completed responses replay for 24 hours.
string
required
Public HTTPS URL, at most 2048 characters. Redirects are not followed.
string[]
required
At least one event type: run.completed, run.failed, run.cancelled, pitch_audit.completed, pitch_audit.failed, site_audit.completed, prompt_suggestions.ready, prompt_suggestions.failed or webhook.test.
string
Free description, at most 200 characters.
string[]
Limit the endpoint to these workspaces, at most 100. Omit it or send an empty array to receive the events of every workspace of the team.
boolean
default:"true"
Whether the endpoint receives events right away.

Response

Returns 201 with Location, ETag and the endpoint, plus the secret.
string
Signing secret. Shown once; it cannot be read again. Rotate it with Rotate the signing secret if you lose it.
The other fields are described in List webhook endpoints.

Synthetic request and response

Errors

See Error codes for authentication, plan, idempotency and server errors. A token without write access returns 403 API_KEY_READ_ONLY. On 429, honor Retry-After. If the write limiter is unavailable or writes are suspended, the request returns 503 SERVICE_UNAVAILABLE and nothing changes.