SKskmtc

Rotate a pipeline's webhook secret

Replace the signing secret of a pipeline's webhook action. The response carries the new secret, shown only this once. The old secret stops at once: every later attempt signs with the new one, including retries of events captured before the rotation. 422 for a pipeline with no webhook action. Signed-in sessions only: a leaked personal access token must not be able to replace the secret and break a working receiver.

post/v1/pipelines/{account}/{pipeline}/rotate-webhook-secret

Request

  • Base URL
    https://api.skmtc.dev
  • URL
    https://api.skmtc.dev/v1/pipelines/{account}/{pipeline}/rotate-webhook-secret
  • Auth
    none declared

Path parameters

accountstring required
pipelinestring required

Response

The request has succeeded.

idstring uuid required

An RFC 4122 UUID, rendered as a string.

namestring required

Unique within the owner account.

status'active' | 'paused' required

Whether a pipeline fires. paused is entered by hand, or after 5 failed deliveries in a row.

consecutiveFailuresinteger required

Failed deliveries in a row; the auto-pause counter.

createdAtstring date-time required
updatedAtstring date-time required
urlstring required

An absolute URL.

htmlUrlstring required

An absolute URL.

webhookSecretstring

The webhook action's signing secret in plaintext, shown only this once. Present when the request added the webhook action, and on rotate. It cannot be read again; rotate it to get a new one.

Changes

No recorded changes to this operation across all 1 revision of this API.