The API reference isn't available right now
This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.
Back to the API reference
No such model
This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.
Back to the API reference
This reference may be out of date
This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.
API reference
/
Models
BeginWebhookSecretRotationResultDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Outcome of starting a webhook signing-secret rotation: the resulting state, plus the incoming
secret in plaintext.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
Field
Type
Description
incomingSecretKey
required
string
The replacement secret, in plaintext. Shown to the operator once; never returned again.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
state
required
WebhookSecretRotationStateDto
WebhookSecretRotationStateDto
The destination's rotation state after the operation.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields of WebhookSecretRotationStateDto:
Field
Type
Description
isRotating
required
boolean
Whether an overlap is open, so deliveries carry two signature values.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
rotationStartedUtc
required
string (date-time)
When the overlap began, UTC. Null when no rotation is in progress.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This body has no documented fields.
This model has no documented fields.
Next steps