SCscalekit
Triggers

Confirm a signing secret rotation

Changed on

Ends a signing-secret rotation by retiring the previous secret, so only the current secret is accepted. Call this endpoint once the provider's app configuration holds the new secret. A rotation is never confirmed automatically: until you call this endpoint, the previous secret stays accepted until its expiry, at most 24 hours after the rotation started. Pass the connection ID in the path, and in the body the signing_secret_rotation_id from the latest SetTriggerSigningSecret or GetTriggerIngressEndpoint response, so that only the rotation you looked at is confirmed. Calling this endpoint when no rotation is in progress succeeds and changes nothing. Returns the endpoint with its masked secret and rotation state.

post/api/v1/connections/{connection_id}/trigger-ingress/signing-secret/confirm

Request

Path parameters

connection_idstring required

ID of the connection, in this environment. Up to 64 characters.

Request body

signing_secret_rotation_idstring int64

The rotation to confirm: the signing_secret_rotation_id from the latest SetTriggerSigningSecret or GetTriggerIngressEndpoint response. Required while a rotation is in progress; a missing or non-matching value is then refused with 400, rather than confirming a rotation you did not look at. Ignored when no rotation is in progress.

Response

The previous secret is retired, or no rotation was in progress; the endpoint's current signing-secret state

connection_idstring

ID of the connection this webhook URL belongs to.

idstring

Unique identifier of the connection's webhook endpoint.

masked_signing_secretstring

The stored secret with all but its last four characters replaced, or every character replaced for a secret of 8 characters or fewer. Present only when one is configured. Enough to compare against the secret the provider's app configuration shows, and never enough to sign with.

previous_signing_secret_expires_atstring date-time

When the previous secret stops being accepted even if the rotation is never confirmed: 24 hours after the rotation started. Absent when no rotation is in progress.

rotation_in_progressboolean

Whether the previous signing secret is still accepted alongside the current one. True from the moment a different secret replaces a stored one until the rotation is confirmed, or until previous_signing_secret_expires_at passes.

signing_secret_configuredboolean

Whether a signing secret is stored. While false, every event sent to the URL is answered with 503 so the provider retries it, and the provider's own URL verification fails.

signing_secret_rotation_idstring int64

Identifies the latest signing-secret rotation; it increases by one each time a rotation starts. Zero when none has ever started. Pass this value to ConfirmTriggerSigningSecretRotation to confirm this specific rotation. A value naming a rotation that a newer one has since replaced is refused rather than confirming the wrong rotation.

urlstring

The URL to paste into the provider's app configuration as the event destination. It is built on your environment's domain, using its custom domain when one is set, and ends in a random token unique to this connection, so treat it as confidential. Returned whether or not a signing secret has been set. The URL accepts request bodies up to 1 MB and answers a larger one with 413. Until a signing secret is set it answers events with 503, so the provider retries them; an event that fails signature verification is answered with 400.

Example response

{
  "connection_id": "conn_28128748834787840",
  "id": "tie_28128748834787840",
  "masked_signing_secret": "************************a4f9",
  "signing_secret_configured": true,
  "url": "https://acme.scalekit.dev/triggers/v1/kq3T9vX2bL8mN4pR7sW1yZ"
}

Changes