Generate a signing secret Beta

POST/api/v1/connections/{connection_id}/trigger-ingress/signing-secret/generate

This endpoint is in beta. Its request and response may change.

Generates a signing secret for an app that doesn't sign its events (provides_bearer_secret is true on its triggers), and returns it once. A generated secret starts with skwh_. Give it to the app, which sends it with every event: in an Authorization: Bearer header, in the X-Scalekit-Webhook-Secret header, or as the last segment of url_with_secret when the app can't set a header. Store it with your server's secrets now; it's never returned again. If a secret already exists, a new one starts a rotation. An app that signs its own events takes its secret through Set a signing secret instead.

This page as markdown Triggers overview

REST
Python

Authorization

Authorization: Bearer $TOKEN, an access token from the client credentials grant. See Authentication.

Path parameters

connection_idstringrequired

The connection whose webhook URL receives the generated secret. Between 1 and 64 characters.

scalekit_client.actions.triggers.generate_signing_secret

Generate a signing secret, for providers that use one Scalekit creates. The secret is returned in plaintext only in this response; it is left out of repr(). Not retried on UNAVAILABLE: a retry would replace the secret.

scalekit_client.actions.triggers.generate_signing_secret(
    connection_id: str,
) -> GenerateTriggerSigningSecretResponse

Parameters

connection_idstrrequired

The connection (conn_...).

Returns GenerateTriggerSigningSecretResponse: The endpoint, the secret and the URL that includes it.

From scalekit-sdk-python 2.23.0.

Response 200

endpointobject

The connection's webhook endpoint after the secret was stored, rendered exactly as Get a webhook URL renders it: the secret appears here only in masked form, and rotation_in_progress is true when this call started a rotation.

Show 8 child attributes

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. Empty when none 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

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

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 Confirm a signing secret rotation 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.

signing_secretstring

The generated secret, in plain text. Returned only in this response and never again by any endpoint, nor written to a log. The provider presents it back on every event in exactly one of three ways: an Authorization: Bearer <secret> header, the X-Scalekit-Webhook-Secret header, or the final path segment of url_with_secret.

url_with_secretstring

Endpoint.url with the secret appended as a final path segment. Paste this into the provider's console when the provider cannot send a custom header. It is as sensitive as signing_secret and is likewise returned only in this response.

Errors

Every error has the same body: code, message and details. See Errors and rate limits.

400Invalid request, nothing written - connection_id is not a valid connection ID; the connection's provider signs its own events, so its secret is copied from the provider's app configuration and stored with Set a signing secret instead (error_code TRIGGER_SIGNING_SECRET_NOT_GENERATABLE); or the provider's webhook trigger definitions are temporarily unavailable (error_code TRIGGER_INGRESS_DEFINITIONS_UNAVAILABLE)

404Not found - no webhook URL has been created for this connection yet (error_code TRIGGER_INGRESS_ENDPOINT_NOT_CREATED; call Create a webhook URL first), the connection does not exist in this environment (error_code RESOURCE_NOT_FOUND), or Triggers isn't turned on for your environment (error_code RESOURCE_NOT_FOUND)

409Conflict - a rotation is already in progress. Confirm it with Confirm a signing secret rotation, or wait for the previous secret's expiry, before generating another secret

500Internal error - the secret could not be generated or stored, or the endpoint could not be read back; retry the request

Request

REST
Python

curl -sS -X POST \
  "$SCALEKIT_ENVIRONMENT_URL/api/v1/connections/conn_133400101014998936/trigger-ingress/signing-secret/generate" \
  -H "Authorization: Bearer $TOKEN"

result = scalekit_client.actions.triggers.generate_signing_secret(
    connection_id="conn_133400101014998936",
)

Response 200

{
  "signing_secret": "skwh_Xq3vR8nT1bLm6KpZ2wYc9DfH4sJg7AeU0oNi5tGr1Bk",
  "url_with_secret": "https://your-env.scalekit.dev/triggers/v1/h3Lp8wQz1nRt6vYc4KmXb9/skwh_Xq3vR8nT1bLm6KpZ2wYc9DfH4sJg7AeU0oNi5tGr1Bk",
  "endpoint": {
    "id": "tie_149528599802681734",
    "connection_id": "conn_133400101014998936",
    "url": "https://your-env.scalekit.dev/triggers/v1/h3Lp8wQz1nRt6vYc4KmXb9",
    "signing_secret_configured": true,
    "masked_signing_secret": "********************************************r1Bk",
    "rotation_in_progress": false,
    "signing_secret_rotation_id": "0"
  }
}