Webhooks

Manage webhook endpoints for real-time events

GET/api/v1/webhooks

List webhooks

Returns all configured webhook endpoints. Requires admin or owner role.

curl https://api.offly.net/api/v1/webhooks \
  -H "Authorization: Bearer YOUR_API_KEY"

Try it

Do not use production API keys on shared devices. Keys are stored in memory only.

API Key

POST/api/v1/webhooks

Create a webhook

Creates a new webhook endpoint. Requires admin or owner role.

Request body

Field	Type	Description
url*	string(uri)
events*	array

Response

Field	Type	Description
id	string(uuid)
url	string(uri)
events	array
is_active	boolean
secret	string	Only returned on creation
created_at	string(date-time)

curl -X POST https://api.offly.net/api/v1/webhooks \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Try it

Do not use production API keys on shared devices. Keys are stored in memory only.

API Key

Request Body (JSON)

PATCH/api/v1/webhooks/{id}

Update a webhook

Parameters

Name	Type	In	Description
id*	string(uuid)	path

Request body

Field	Type	Description
url	string(uri)
events	array
is_active	boolean

Response

Field	Type	Description
id	string(uuid)
url	string(uri)
events	array
is_active	boolean
secret	string	Only returned on creation
created_at	string(date-time)

curl -X PATCH https://api.offly.net/api/v1/webhooks/{id} \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Try it

Do not use production API keys on shared devices. Keys are stored in memory only.

API Key

Request Body (JSON)

DELETE/api/v1/webhooks/{id}

Delete a webhook

Parameters

Name	Type	In	Description
id*	string(uuid)	path

curl -X DELETE https://api.offly.net/api/v1/webhooks/{id} \
  -H "Authorization: Bearer YOUR_API_KEY"

Try it

Do not use production API keys on shared devices. Keys are stored in memory only.

API Key