POST
/
v1
/
webhook-endpoints
/
{id}
/
rotate-secret
Rotate webhook signing secret
curl --request POST \
  --url https://sandbox.authbound.io/v1/webhook-endpoints/{id}/rotate-secret \
  --header 'X-Authbound-Key: <api-key>'
{
  "id": "00000000-0000-4000-8000-000000000123",
  "object": "webhook_endpoint",
  "url": "<string>",
  "enabled_events": [
    "verification.completed",
    "verification.failed"
  ],
  "secret_prefix": "whsec_abcd1234",
  "failure_count": 1,
  "last_success_at": "2023-11-07T05:31:56Z",
  "last_failure_at": "2023-11-07T05:31:56Z",
  "disabled_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "secret": "whsec_abc123xyz"
}

Authorizations

X-Authbound-Key
string
header
required

Server-side secret key header. Format: sk_live_* (production) or sk_test_* (testing).

Path Parameters

id
string
required

Response

New secret generated

id
string<uuid>
required
Example:

"00000000-0000-4000-8000-000000000123"

object
enum<string>
required
Available options:
webhook_endpoint
url
string<uri>
required
status
enum<string>
required
Available options:
enabled,
disabled
enabled_events
enum<string>[]
required
Available options:
verification.state_changed,
verification.completed,
verification.failed,
verification.canceled,
verification.expired
Example:
[
"verification.completed",
"verification.failed"
]
secret_prefix
string
required

Display-safe prefix of the endpoint signing secret.

Example:

"whsec_abcd1234"

env_mode
enum<string>
required

Environment that owns the endpoint.

Available options:
test,
live
failure_count
integer
required

Consecutive failed delivery attempts for this endpoint.

Required range: x >= 0
last_success_at
string<date-time> | null
required
last_failure_at
string<date-time> | null
required
disabled_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
secret
string
required

HMAC signing secret (only shown once)

Example:

"whsec_abc123xyz"