Create a webhook
Registers an endpoint that receives platform events as signed HTTP POSTs. Requests follow the Standard Webhooks specification: ‘webhook-id’, ‘webhook-timestamp’, and ‘webhook-signature’ headers, where the signature is an HMAC-SHA256 of ’..’, base64-encoded and prefixed ‘v1,’. The response is the only place the signing secret is returned — store it, it cannot be read back.
Authorizations
Bearer token for authentication. Format: 'Bearer {token}'
Headers
Workspace ID (uses default workspace if not provided)
Body
Create a webhook
Display name (must be unique within the workspace)
Destination URL; must be an http or https URL
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
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 to scope this webhook to. Omit or send an empty array for every app in the workspace.
Whether deliveries are sent (default true)
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 (default false).
Response
Create a webhook
Api_V1_Entities_Webhook model
Unique webhook identifier
Display name (unique per workspace)
Destination URL events are POSTed to
Whether deliveries are currently sent
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 this webhook is scoped to. Empty means every app in the workspace.
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.
Signing secret, formatted 'whsec_'. Returned ONLY in the create response — store it, it cannot be read back.
Creation timestamp
Last update timestamp

