Skip to content
Courier docs

Issues a new signing secret and invalidates the old one.

POST
/v1/webhooks/{id}/rotate-secret
curl --request POST \
  --url https://courierapi.itdlogisoft.co.uk/v1/webhooks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/rotate-secret \
  --header 'Authorization: Basic <credentials>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json

A registered endpoint.

string? WebhookResponse.SigningSecret is present only in the response that created or rotated it, and is never readable again. Store it: it is the only thing that proves a request to your endpoint came from us.

object
id
required
string
url
required
string
status
required
string
events
required
Array<string>
created_at
required
string format: date-time
last_succeeded_at
required
null | string format: date-time
last_failed_at
required
null | string format: date-time
consecutive_failures
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
suspension_reason
required
null | string
signing_secret
null | string

Example generated

{
  "id": "example",
  "url": "example",
  "status": "example",
  "events": [
    "example"
  ],
  "created_at": "2026-04-15T12:00:00Z",
  "last_succeeded_at": "2026-04-15T12:00:00Z",
  "last_failed_at": "2026-04-15T12:00:00Z",
  "consecutive_failures": 1,
  "suspension_reason": "example",
  "signing_secret": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/json

The shape of every refusal from this API.

string ApiError.Code is stable and machine-readable; string ApiError.Message is for a human reading a log and may change without notice. Integrators are told to branch on the code.

object
code
required
string
message
required
string

Example generated

{
  "code": "example",
  "message": "example"
}