Skip to main content
PUT
Save a webhook URL's secret

Authorizations

X-API-Key
string
header
required

Path Parameters

table_id
string<uuid>
required
endpoint_id
string<uuid>
required
kind
enum<string>
required

What a webhook secret is for.

Available options:
signing_secret,
static_token,
verify_token

Body

application/json

A secret copied from the app, and what happens to the one it replaces.

secret
string<password>
required
write-only

The secret exactly as the app shows it. It is never shown again.

Required string length: 1 - 1024
old_secret
enum<string>
default:keep_for_36_hours

keep_for_36_hours keeps the secret this one replaces working for 36 hours, while the app switches; stop_now ends it at once, for a secret that leaked.

Available options:
stop_now,
keep_for_36_hours

Response

Successful Response

A secret of a webhook URL: what it is for and its last characters, never the secret.

created_at
string<date-time>
required

When it was saved.

current
boolean
required

True for the secret in use; false for a replaced one still accepted.

expires_at
string<date-time> | null
required

Until when a replaced secret is still accepted; empty for the current one.

hint
string
required

Its last 4 characters, to tell secrets apart; only … for a short one.

id
string<uuid>
required

The secret's id.

kind
enum<string>
required

What the secret is for.

Available options:
signing_secret,
static_token,
verify_token
source
enum<string>
required

Where it came from.

Available options:
customer,
subscription,
connection,
generated