Skip to main content
Create a project webhook

Path Parameters

project_id
string
required

Body

application/json

Request body for creating a project webhook.

url
string
required

HTTPS destination URL.

events
enum<string>[]
required

Events that should trigger delivery.

Minimum array length: 1

Supported webhook events (namespaced by resource family).

Add new members as more resources gain webhook fire points. Validation lives in the API layer; the DB does not hard-code the allowed set.

Available options:
pipeline.completed,
pipeline.failed,
pipeline.canceled,
simple_pipeline.completed,
simple_pipeline.failed,
simple_pipeline.canceled
enabled
boolean
default:true

Whether the webhook is active.

Response

Successful Response

Create response that includes the signing secret once.

id
string
required
project_id
string
required
organization_id
string
required
url
string
required
events
string[]
required
enabled
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
secret
string
required

HMAC signing secret; shown only in the create response.

consecutive_failures
integer
default:0
disabled_reason
string | null
created_by
string | null