Skip to main content
PUT
Create or update the partner webhook URL, subscribed events, enabled state, and signing secret rotation.

Authorizations

Authorization
string
header
required

Partner API key. Keep server-side; do not expose in public clients.

Body

application/json
url
string<uri>
required
events
enum<string>[]

Empty or omitted uses the default action lifecycle events.

Available options:
partner_action.created,
partner_action.submitted,
partner_action.failed,
partner_action.claimable,
partner_action.claimed,
partner_action.cancelled
enabled
boolean
rotateSecret
boolean

Set true to return a new webhook signing secret.

Response

OK

success
boolean
required
data
object | null
required
meta
object
required