Events and webhooks · API

List Events

GET/v1/events

API key requiredSuccess 200

Parameters

Name	Type	Description
`after`query	integer	Default `0`; range ≥ 0
`limit`query	integer	Default `50`; range 1–200
`X-Project-ID`header	string	The project to act on; the default project when omitted; nullable

Response 200 application/json

Name	Type	Description
`data`required	array<object>
`data[].id`required	string
`data[].sequence`required	integer
`data[].type`required	string
`data[].created_at`required	number
`data[].api_version`required	string
`data[].project_id`required	string	nullable
`data[].data`required	object
`next_cursor`required	integer	Sequence number to pass as `after`; unchanged when the page is empty
`has_more`	boolean	Default `false`

Example

curl "https://axiomlab.online/v1/events" \
  -H "Authorization: Bearer $AZIMO_API_KEY"

List Webhooks

GET/v1/webhooks

API key requiredSuccess 200

Parameters

Name	Type	Description
`limit`query	integer	Default `50`; range 1–200
`cursor`query	string	length ≤ 256; nullable
`after`query	string	length ≤ 256; nullable
`X-Project-ID`header	string	The project to act on; the default project when omitted; nullable

Response 200 application/json

Name	Type	Description
`data`required	array<object>
`data[].id`required	string
`data[].project_id`required	string	nullable
`data[].kind`required	string
`data[].name`required	string
`data[].version`required	integer
`data[].created_at`required	number
`data[].updated_at`required	number
`data[].data`required	object
`data[].data.name`required	string
`data[].data.url`required	string
`data[].data.active`	boolean	Default `true`
`data[].data.has_secret`required	boolean
`next_cursor`	string	Opaque; pass as `cursor` (or the `after` alias) for the next page; nullable
`has_more`	boolean	Default `false`

Example

curl "https://axiomlab.online/v1/webhooks" \
  -H "Authorization: Bearer $AZIMO_API_KEY"

Create Webhook

POST/v1/webhooks

API key requiredSuccess 201

Parameters

Name	Type	Description
`Idempotency-Key`header	string	A unique value you generate and keep; reuse it when retrying so the request never runs twice; length 1–128; nullable
`X-Project-ID`header	string	The project to act on; the default project when omitted; nullable

Request body application/json

Name	Type	Description
`name`	string	Default `Webhook`; length ≤ 160
`url`required	string	length ≤ 2000
`active`	boolean	Default `true`

Response 201 application/json

Name	Type	Description
`id`required	string
`project_id`required	string	nullable
`kind`required	string
`name`required	string
`version`required	integer
`created_at`required	number
`updated_at`required	number
`data`required	object
`data.name`required	string
`data.url`required	string
`data.active`	boolean	Default `true`
`data.has_secret`required	boolean
`signing_secret`required	string	Shown at creation/rotation and for the same actor's idempotent retry within 24 hours; nullable

Example

curl -X POST "https://axiomlab.online/v1/webhooks" \
  -H "Authorization: Bearer $AZIMO_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"url": "<url>"}'

Rotate Webhook Secret

POST/v1/webhooks/{webhook_id}/rotate-secret

API key requiredSuccess 200

Parameters

Name	Type	Description
`webhook_id`requiredpath	string
`expected_version`requiredquery	integer	range ≥ 1
`Idempotency-Key`header	string	A unique value you generate and keep; reuse it when retrying so the request never runs twice; length 1–128; nullable
`X-Project-ID`header	string	The project to act on; the default project when omitted; nullable

Response 200 application/json

Name	Type	Description
`id`required	string
`project_id`required	string	nullable
`kind`required	string
`name`required	string
`version`required	integer
`created_at`required	number
`updated_at`required	number
`data`required	object
`data.name`required	string
`data.url`required	string
`data.active`	boolean	Default `true`
`data.has_secret`required	boolean
`signing_secret`required	string	Shown at creation/rotation and for the same actor's idempotent retry within 24 hours; nullable

Example

curl -X POST "https://axiomlab.online/v1/webhooks/<webhook_id>/rotate-secret?expected_version=<expected_version>" \
  -H "Authorization: Bearer $AZIMO_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Update Webhook

PUT/v1/webhooks/{webhook_id}

API key requiredSuccess 200

Parameters

Name	Type	Description
`webhook_id`requiredpath	string
`expected_version`requiredquery	integer	range ≥ 1
`X-Project-ID`header	string	The project to act on; the default project when omitted; nullable

Request body application/json

Name	Type	Description
`name`	string	Default `Webhook`; length ≤ 160
`url`required	string	length ≤ 2000
`active`	boolean	Default `true`

Response 200 application/json

Name	Type	Description
`id`required	string
`project_id`required	string	nullable
`kind`required	string
`name`required	string
`version`required	integer
`created_at`required	number
`updated_at`required	number
`data`required	object
`data.name`required	string
`data.url`required	string
`data.active`	boolean	Default `true`
`data.has_secret`required	boolean

Example

curl -X PUT "https://axiomlab.online/v1/webhooks/<webhook_id>?expected_version=<expected_version>" \
  -H "Authorization: Bearer $AZIMO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "<url>"}'

Delete Webhook

DELETE/v1/webhooks/{webhook_id}

API key requiredSuccess 200

Parameters

Name	Type	Description
`webhook_id`requiredpath	string
`X-Project-ID`header	string	The project to act on; the default project when omitted; nullable

Response 200 application/json

Name	Type	Description
`id`required	string
`deleted`	boolean	Default `true`

Example

curl -X DELETE "https://axiomlab.online/v1/webhooks/<webhook_id>" \
  -H "Authorization: Bearer $AZIMO_API_KEY"

List Deliveries

GET/v1/webhook-deliveries

API key requiredSuccess 200

Parameters

Name	Type	Description
`limit`query	integer	Default `50`; range 1–200
`cursor`query	string	length ≤ 256; nullable
`after`query	string	length ≤ 256; nullable
`X-Project-ID`header	string	The project to act on; the default project when omitted; nullable

Response 200 application/json

Name	Type	Description
`data`required	array<object>
`data[].id`required	string
`data[].event_id`required	string
`data[].url`required	string
`data[].status`required	string
`data[].attempts`required	integer
`data[].last_error`required	string	nullable
`data[].delivered_at`required	number	nullable
`next_cursor`	string	Opaque; pass as `cursor` (or the `after` alias) for the next page; nullable
`has_more`	boolean	Default `false`

Example

curl "https://axiomlab.online/v1/webhook-deliveries" \
  -H "Authorization: Bearer $AZIMO_API_KEY"

Replay

POST/v1/webhook-deliveries/{delivery_id}/replay

API key requiredSuccess 202

Parameters

Name	Type	Description
`delivery_id`requiredpath	string
`webhook_id`query	string	length ≤ 32; nullable
`Idempotency-Key`header	string	A unique value you generate and keep; reuse it when retrying so the request never runs twice; length 1–128; nullable
`X-Project-ID`header	string	The project to act on; the default project when omitted; nullable

Response 202 application/json

Name	Type	Description
`id`required	string
`status`required	string	One of: `pending`

Example

curl -X POST "https://axiomlab.online/v1/webhook-deliveries/<delivery_id>/replay" \
  -H "Authorization: Bearer $AZIMO_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"