Skip to main content
POST
SDK (@phosra/sdk)
Webhooks deliver real-time events — enforcement completions, verification changes, policy updates — to an HTTPS endpoint you control. Register one, send a test delivery, and inspect the delivery log.
Use Send a test delivery to fire a sample payload, then read List deliveries to confirm receipt and debug retries.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
family_id
string<uuid>
required
url
string
required

Webhook URL to receive events

events
string[]
required

Events to subscribe to (e.g. policy.updated, enforcement.completed)

Response

Webhook created

id
string<uuid>

Unique identifier for this resource.

family_id
string<uuid>

Identifier of the family this resource belongs to.

url
string

HTTPS endpoint that receives POSTed webhook events.

events
string[]

List of event types this webhook subscribes to.

active
boolean

Whether the webhook is currently active and receiving deliveries.

created_at
string<date-time>

RFC 3339 timestamp of when the resource was created.

updated_at
string<date-time>

RFC 3339 timestamp of the resource's most recent update.