The webhook object

⚠️

Preview — this feature is being built; the design below is the spec.

The webhook object as the API returns it. Every field below appears in every response that returns this object; fields with no value are null rather than missing.

Example

{
  "id": "whk_01JCA4C6E8G0J2L4N6Q8",
  "object": "webhook",
  "url": "https://hooks.example.com/syntic",
  "events": [
    "batch.completed",
    "session.requires_action",
    "deployment.run.failed"
  ],
  "description": "Ops alerts",
  "status": "enabled",
  "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
  "created_at": "2026-11-05T09:00:00Z",
  "updated_at": "2026-11-05T09:00:00Z",
  "last_delivery": null,
  "signing_secret": "whsec_6Jt2Qm9...redacted"
}

Fields

Field	Type	Description
`id`	string	Starts with `whk_`.
`object`	string	Always `webhook`.
`url`	string	Where deliveries are sent. HTTPS, public address.
`events`	array	Event types delivered, or `["*"]` for all.
`description`	string or null	Up to 200 characters.
`status`	string	`enabled` or `disabled`. Syntic disables an endpoint that has failed every delivery for 3 days.
`workspace_id`	string	Only this workspace’s events are delivered.
`created_at`	string	RFC 3339 UTC.
`updated_at`	string	RFC 3339 UTC.
`last_delivery`	object or null	Time, HTTP status and outcome of the most recent attempt.
`signing_secret`	string	Starts with `whsec_`. Returned only by this call and by rotate-secret.

Returned by

vault workspace

Was this page helpful?