boundry.
RegionSydney, Australia
Documentation/Rotate a webhook signing secret
POST/webhooks/{webhookId}/rotate-secret

Rotate a webhook signing secret

Authentication

Bearer authentication is required for this operation.

Path parameters

NameTypeDescription
webhookIdrequiredstring

Webhook identifier.

Request body

FieldTypeDescription
expires_ininteger

Overlap duration in seconds; defaults to 24 hours.

Request examples

request.sh
bash
curl --request POST 'https://api.au.boundry.dev/webhooks/string/rotate-secret' \
+  -H 'Authorization: Bearer $BOUNDRY_API_KEY' \
+  -H 'Content-Type: application/json' \
+  --data '{"expires_in":86400,"webhookId":"wh_01j0example"}'

200 response

One-time replacement signing secret.

FieldTypeDescription
idrequiredstring

Webhook identifier. Example: "msg_01j0example".

objectrequiredstring

Resource type discriminator. Values: "webhook".

previous_secret_expires_atrequiredstring (date-time)

Timestamp when the previous secret stops signing. Example: "2026-08-14T12:00:00.000Z".

signing_secretrequiredstring

One-time replacement signing secret.

response.jsonExample response
application/json
{
  "expires_in": 86400,
  "webhookId": "wh_01j0example"
}

400 response

Request body was not valid JSON.

FieldTypeDescription
errorsarray

Detailed validation issues. Absent only for the historical 401 API-key envelope.

coderequiredstring

Zod validation issue code. Example: "invalid_format".

messagerequiredstring

Human-readable validation failure. Example: "Invalid email address".

pathrequiredstring

Dot-separated location of the invalid value. Example: "from".

messagerequiredstring

Human-readable error message. Example: "Request validation failed.".

namerequiredstring

Machine-readable error category. Values: "validation_error", "application_error", "not_found". Example: "validation_error".

response.jsonExample response
application/json
{
  "expires_in": 86400,
  "webhookId": "wh_01j0example"
}

401 response

Invalid API key.

FieldTypeDescription
errorsarray

Detailed validation issues. Absent only for the historical 401 API-key envelope.

coderequiredstring

Zod validation issue code. Example: "invalid_format".

messagerequiredstring

Human-readable validation failure. Example: "Invalid email address".

pathrequiredstring

Dot-separated location of the invalid value. Example: "from".

messagerequiredstring

Human-readable error message. Example: "Request validation failed.".

namerequiredstring

Machine-readable error category. Values: "validation_error", "application_error", "not_found". Example: "validation_error".

response.jsonExample response
application/json
{
  "expires_in": 86400,
  "webhookId": "wh_01j0example"
}

404 response

Webhook, delivery, or event not found.

FieldTypeDescription
errorsarray

Detailed validation issues. Absent only for the historical 401 API-key envelope.

coderequiredstring

Zod validation issue code. Example: "invalid_format".

messagerequiredstring

Human-readable validation failure. Example: "Invalid email address".

pathrequiredstring

Dot-separated location of the invalid value. Example: "from".

messagerequiredstring

Human-readable error message. Example: "Request validation failed.".

namerequiredstring

Machine-readable error category. Values: "validation_error", "application_error", "not_found". Example: "validation_error".

response.jsonExample response
application/json
{
  "expires_in": 86400,
  "webhookId": "wh_01j0example"
}

422 response

Request validation failed.

FieldTypeDescription
errorsarray

Detailed validation issues. Absent only for the historical 401 API-key envelope.

coderequiredstring

Zod validation issue code. Example: "invalid_format".

messagerequiredstring

Human-readable validation failure. Example: "Invalid email address".

pathrequiredstring

Dot-separated location of the invalid value. Example: "from".

messagerequiredstring

Human-readable error message. Example: "Request validation failed.".

namerequiredstring

Machine-readable error category. Values: "validation_error", "application_error", "not_found". Example: "validation_error".

response.jsonExample response
application/json
{
  "expires_in": 86400,
  "webhookId": "wh_01j0example"
}