Skip to content

Rotate Webhook Secret

POST
/webhooks/{webhook_id}/rotate-secret

Rotate the signing secret for a webhook subscription. Returns the new secret (shown once).

Authorizations

Parameters

Path Parameters

webhook_id
required

Webhook subscription ID

string

Webhook subscription ID

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
object
created_at
Any of:
string
environment

‘live’ or ‘sandbox’: which events this subscription receives.

string
default: live
events
Array<string>
default:
field_filters
Any of:
object
key
additional properties
Array<string>
id
required
string
is_active
boolean
default: true
name
Any of:
string
secret
Any of:
string
updated_at
Any of:
string
url
required
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string