POST
Create a webhook

Authorizations

Authorization
string
header
required

Bearer token for authentication. Format: 'Bearer {token}'

Headers

X-Workspace-Id
string

Workspace ID (uses default workspace if not provided)

Body

application/json

Create a webhook

name
string
required

Display name (must be unique within the workspace)

url
string
required

Destination URL; must be an http or https URL

event_filter
enum<string>[]
required

Event types to subscribe to: 'deploy_started', 'deploy_ended'

Available options:
deploy_started,
deploy_ended
app_uuids
string[]

App UUIDs to scope this webhook to. Omit or send an empty array for every app in the workspace.

enabled
boolean
default:true

Whether deliveries are sent (default true)

Response

Create a webhook

Api_V1_Entities_Webhook model

uuid
string
required

Unique webhook identifier

name
string
required

Display name (unique per workspace)

url
string
required

Destination URL events are POSTed to

enabled
boolean
required

Whether deliveries are currently sent

event_filter
any[]
required

Event types this webhook subscribes to: 'deploy_started', 'deploy_ended'

app_uuids
any[]
required

App UUIDs this webhook is scoped to. Empty means every app in the workspace.

secret
string
required

Signing secret, formatted 'whsec_'. Returned ONLY in the create response — store it, it cannot be read back.

created_at
string<date-time>
required

Creation timestamp

updated_at
string<date-time>
required

Last update timestamp