Skip to main content
POST
Register an HTTPS URL that Penbox calls every time a case of the workspace changes. Events, payload and signature are described in the Webhooks guide. The response carries the secret that signs every call. Store it on your server; you can read it again with List Webhooks.
The URL must use https. localhost, .local hosts and private IP addresses (loopback, 10.x, 172.16–31.x, 192.168.x, link-local, IPv6 unique-local) are refused with a 422. A URL already registered on the workspace is refused with a 409: register it once, not at each start of your app.

Authorizations

Authorization
string
header
required

API token (starts with pnbx_). Create at https://app.penbox.io/workspace/settings/api. Include as: Authorization: Bearer {token}

Body

application/json
workspace
object
required
url
string<uri>
required

An HTTPS URL. localhost is refused.

Example:

"https://api.example.com/penbox/webhooks"

events
enum<string>[]

The events to receive. Defaults to all three.

Minimum array length: 1
Available options:
case.created,
case.updated,
case.deleted

Response

Endpoint registered

id
string<uuid>
required

Endpoint ID

workspace
object
required

The workspace whose cases this endpoint follows

url
string<uri>
required

The HTTPS URL Penbox calls

events
enum<string>[]
required

The events sent to this endpoint

Available options:
case.created,
case.updated,
case.deleted
secret
string
required

The secret that signs every call (Penbox-Signature header). Keep it on your server.

Example:

"whsec_4f1c…"

created_at
string<date-time>

When the endpoint was registered