GEgetaxonflow
Webhooks

Create webhook subscription

Create a new webhook subscription to receive real-time event notifications. Events are delivered as HTTP POST requests to the specified URL with HMAC-SHA256 signatures when a secret is provided.

post/api/v1/webhooks

Request

Request body

urlstring uri required

URL to receive webhook event payloads

eventsstring[] required

List of event types to subscribe to. Available events:

  • policy.violation — Policy violation detected
  • policy.created / policy.updated / policy.deleted — Policy lifecycle
  • workflow.completed / workflow.failed / workflow.aborted — Workflow lifecycle
  • workflow.approval_required — Step requires human approval
  • budget.threshold_reached / budget.exceeded / budget.blocked — Budget alerts
  • plan.completed / plan.failed — Plan lifecycle
secretstring

Secret key for HMAC-SHA256 signature verification of webhook payloads

activeboolean

Whether the subscription is active

Example request

{
  "url": "https://example.com/webhooks/axonflow",
  "events": [
    "policy.violation",
    "workflow.completed"
  ],
  "secret": "whsec_example_placeholder"
}

Response

Webhook subscription created

idstring

Unique subscription identifier

urlstring uri

URL that receives webhook event payloads

eventsstring[]

Event types this subscription listens for

activeboolean

Whether the subscription is currently active

tenant_idstring

Tenant ID that owns this subscription

org_idstring

Organization ID that owns this subscription

secretstring

Secret key for HMAC-SHA256 signature verification

created_atstring date-time

When the subscription was created

updated_atstring date-time

When the subscription was last updated

Example response

{
  "id": "wh_abc123",
  "url": "https://example.com/webhooks/axonflow",
  "events": [
    "policy.violation",
    "workflow.completed"
  ],
  "active": true,
  "tenant_id": "tenant-1",
  "org_id": "org-1",
  "secret": "whsec_example_placeholder"
}

Changes

No recorded changes to this operation across all 1 revision of this API.