PUT
Update 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)

Path Parameters

uuid
string
required

Webhook UUID

Body

application/json

Update a webhook

name
string

Display name (must be unique within the workspace)

url
string

Destination URL; must be an http or https URL

event_filter
enum<string>[]

Event types to subscribe to. One or more of: deploy_started, deploy_ended, app_unhealthy, app_crash_loop, app_stopped, app_state_changed, app_blocked, scaling_limit_reached, certificate_expiring, domain_verified, quota_alert

Available options:
deploy_started,
deploy_ended,
app_unhealthy,
app_crash_loop,
app_stopped,
app_state_changed,
app_blocked,
scaling_limit_reached,
certificate_expiring,
domain_verified,
quota_alert
app_uuids
string[]

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

enabled
boolean

Whether deliveries are sent

include_review_apps
boolean

Also send events from preview environments of the scoped apps. A preview environment has its own app UUID, so app_uuids alone does not cover it.

Response

Update 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. One or more of: deploy_started, deploy_ended, app_unhealthy, app_crash_loop, app_stopped, app_state_changed, app_blocked, scaling_limit_reached, certificate_expiring, domain_verified, quota_alert

app_uuids
any[]
required

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

include_review_apps
boolean
required

Whether events from preview environments of the scoped apps are sent. A preview environment has its own app UUID, so it is not covered by app_uuids alone.

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