Skip to main content
PATCH
Update a webhook endpoint

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-workspace-id
string

The workspace to act in, from GET /api/v1/workspaces. Omit to act in the organisation's default workspace. A workspace the key's user cannot act in is treated as omitted.

Path Parameters

endpointId
string
required

Body

application/json
url
string<uri>
description
string | null
events
enum<string>[]
Minimum array length: 1
Available options:
PACKAGE_SENT,
PACKAGE_COMPLETED,
PACKAGE_VOIDED,
PACKAGE_EXPIRED,
PACKAGE_DECLINED,
SESSION_SENT,
SESSION_OPENED,
SESSION_COMPLETED,
SESSION_DECLINED
enabled
boolean

Response

Success

data
object
required