Webhooks
Create Webhook
Register a URL to be told when the cases of a workspace change
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
API token (starts with pnbx_). Create at https://app.penbox.io/workspace/settings/api. Include as: Authorization: Bearer {token}
Body
application/json
Response
Endpoint registered
Endpoint ID
The workspace whose cases this endpoint follows
The HTTPS URL Penbox calls
The events sent to this endpoint
Available options:
case.created, case.updated, case.deleted The secret that signs every call (Penbox-Signature header). Keep it on your server.
Example:
"whsec_4f1c…"
When the endpoint was registered