Skip to main content
POST
Create a webhook endpoint

Authorizations

Authorization
string
header
required

Session access token (JWT) from POST /v1/auth/login or /v1/auth/refresh. A session satisfies every API scope.

Body

application/json
url
string<uri>
required
Maximum string length: 2048
description
string | null

Trimmed; blank becomes null.

Maximum string length: 200
events
enum<string>[] | null

Events to receive. Empty, null or omitted means every event, including ones added later. Duplicates are collapsed.

Available options:
invoice.paid,
invoice.refunded,
team.member_joined,
team.member_removed,
team.service_shared,
service.provisioned,
service.suspended,
service.unsuspended,
service.terminated,
ticket.replied

Response

Endpoint created.

success
boolean
required
data
object
required