SCscalekit
Triggers

Create a connection's webhook URL

Changed on

Creates the webhook URL a provider sends this connection's events to. Use this endpoint once per connection when you set up a webhook trigger: paste the returned URL into the provider's app configuration, then store the provider's signing secret with SetTriggerSigningSecret. Pass the connection ID in the path; the request has no body. Only a connection whose provider publishes at least one webhook trigger can have a webhook URL. The call is idempotent: when the connection already has a URL, that URL is returned unchanged, so a retry never replaces a URL already registered with the provider. The URL accepts request bodies up to 1 MB. Returns the endpoint ID, the URL and the signing-secret state; the signing secret itself is never returned.

post/api/v1/connections/{connection_id}/trigger-ingress

Request

Path parameters

connection_idstring required

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

Response

The newly created webhook URL, or the connection's existing one unchanged, with its 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