Webhooks

Webhook endpoints let a workspace receive monitor events at an HTTPS target and inspect recent delivery attempts.

GET /v1/webhooks

Returns the workspace webhook configuration.

{
  "webhook": {
    "configured": true,
    "url": "https://example.com/omnist/webhooks",
    "enabled": true,
    "signing_secret": {
      "version": 2,
      "preview": "whsec_...abcd"
    }
  }
}

PUT /v1/webhooks

Creates or updates the webhook target.

Request body

Field	Type	Required	Notes
url	string	Required unless a target already exists	HTTPS target URL.
enabled	boolean	No	Defaults to the existing value, or true for a new target.

{
  "url": "https://example.com/omnist/webhooks",
  "enabled": true
}

The response includes new_signing_secret when a secret is first created.

POST /v1/webhooks/rotate-signing-secret

Rotates the signing secret and returns the new secret once. Store it immediately; later reads only include a preview.

POST /v1/webhooks/test

Queues and immediately attempts a test delivery to the configured target.

{
  "delivery": {
    "id": "delivery_...",
    "event_id": "event_...",
    "event_type": "webhook.test",
    "delivery_status": "succeeded",
    "attempt_count": 1,
    "last_http_status": 200
  }
}

GET /v1/webhooks/test

Fetches a test delivery by id, or the most recent test deliveries when no ID is supplied.

Query parameters:

Parameter	Type	Notes
id	number	Optional test delivery ID.

GET /v1/webhooks/events

Lists recent delivery attempt records.

Query parameters:

Parameter	Type	Notes
page	number	Defaults to 1; page size is 50.
start	ISO datetime	Start of inspection window.
end	ISO datetime	End of inspection window.

GET /v1/webhooks/stats

Returns delivery-attempt counts grouped by time bucket and status.

{
  "bucket_minutes": 60,
  "start_at": "2026-05-07T00:00:00Z",
  "end_at": "2026-05-08T00:00:00Z",
  "stats": [
    {
      "bucket_start": "2026-05-07T14:00:00Z",
      "delivery_status": "succeeded",
      "attempt_count": 12
    }
  ]
}