Triggers Beta

A trigger tells your app when something changes in a user's connected app, such as a new lead in Salesforce or a message in Slack. Subscribe a connected account, or a whole connection, to a trigger, and Scalekit sends each event to your delivery endpoint. See How triggers work and Receive trigger events.

A webhook trigger also needs a webhook URL for the connection, registered in your app at the provider, and a signing secret for it. For an app that signs its events, that's the app's own secret: set it. For an app that doesn't, Scalekit generates one. This secret covers the events the app sends to Scalekit. It isn't your delivery endpoint's whsec_ secret, which Scalekit signs the events it sends to you with. A polling trigger needs neither: Scalekit checks the app on the interval you set.

While Triggers isn't turned on for your environment, every endpoint here returns 404. Contact us to turn it on.

This page as markdown Whole reference as one file

Method	Endpoint	Path	What it does	SDKs
GET	List available triggersBetaList a connection's triggers, and whether each one can run on it.	`/api/v1/connections/{connection_id}/triggers`	List a connection's triggers, and whether each one can run on it.	Python
GET	List accounts eligible for a triggerBetaList a connection's connected accounts, and whether each can subscribe to a trigger.	`/api/v1/connections/{connection_id}/triggers/{trigger_name}/eligible-accounts`	List a connection's connected accounts, and whether each can subscribe to a trigger.	Python
GET	List trigger subscriptionsBetaList a connection's trigger subscriptions, with each one's status.	`/api/v1/connections/{connection_id}/trigger-subscriptions`	List a connection's trigger subscriptions, with each one's status.	Python
POST	Subscribe to a triggerBetaSubscribe one connected account, or a whole connection, to a trigger.	`/api/v1/connections/{connection_id}/trigger-subscriptions`	Subscribe one connected account, or a whole connection, to a trigger.	Python
POST	Subscribe several accounts to a triggerBetaSubscribe up to 100 connected accounts to a trigger, with a result for each.	`/api/v1/connections/{connection_id}/trigger-subscriptions:batchCreate`	Subscribe up to 100 connected accounts to a trigger, with a result for each.	Python
DELETE	Delete a trigger subscriptionBetaDelete one trigger subscription.	`/api/v1/connections/{connection_id}/trigger-subscriptions/{subscription_id}`	Delete one trigger subscription.	Python
POST	Delete several trigger subscriptionsBetaDelete up to 100 subscriptions, by ID or by account, with a result for each.	`/api/v1/connections/{connection_id}/trigger-subscriptions:batchDelete`	Delete up to 100 subscriptions, by ID or by account, with a result for each.	Python
POST	Create a webhook URLBetaCreate the URL an app sends a connection's webhook events to.	`/api/v1/connections/{connection_id}/trigger-ingress`	Create the URL an app sends a connection's webhook events to.	Python
GET	Get a webhook URLBetaGet a connection's webhook URL and the state of its signing secret.	`/api/v1/connections/{connection_id}/trigger-ingress`	Get a connection's webhook URL and the state of its signing secret.	Python
PUT	Set a signing secretBetaSave the signing secret the app signs its webhook events with.	`/api/v1/connections/{connection_id}/trigger-ingress/signing-secret`	Save the signing secret the app signs its webhook events with.	Python
POST	Confirm a signing secret rotationBetaRetire the previous signing secret once the app uses the new one.	`/api/v1/connections/{connection_id}/trigger-ingress/signing-secret/confirm`	Retire the previous signing secret once the app uses the new one.	Python
POST	Generate a signing secretBetaGenerate a secret for an app that sends no signature of its own.	`/api/v1/connections/{connection_id}/trigger-ingress/signing-secret/generate`	Generate a secret for an app that sends no signature of its own.	Python
GET	List deliveriesBetaList the trigger events sent to your delivery endpoint, with their state.	`/api/v1/trigger-delivery/endpoints/{endpoint_id}/deliveries`	List the trigger events sent to your delivery endpoint, with their state.	Python
GET	List the attempts for a deliveryBetaList every attempt to deliver one event to your endpoint.	`/api/v1/trigger-delivery/endpoints/{endpoint_id}/deliveries/{msg_id}/attempts`	List every attempt to deliver one event to your endpoint.	Python
GET	List recent delivery attemptsBetaList the most recent delivery attempts to your endpoint.	`/api/v1/trigger-delivery/endpoints/{endpoint_id}/attempts`	List the most recent delivery attempts to your endpoint.	Python
GET	Look up a deliveryBetaFind one event by its message ID or event ID, with its delivery attempts.	`/api/v1/trigger-delivery/deliveries/{id}`	Find one event by its message ID or event ID, with its delivery attempts.	Python
POST	Look up several deliveriesBetaFind up to 25 events by message ID or event ID, with a result for each.	`/api/v1/trigger-delivery/deliveries:batchLookup`	Find up to 25 events by message ID or event ID, with a result for each.	Python
POST	Resend deliveriesBetaSend up to 50 events to your endpoint again, with a result for each.	`/api/v1/trigger-delivery/deliveries:batchResend`	Send up to 50 events to your endpoint again, with a result for each.	Python
POST	Recover failed deliveriesBetaResend every event that failed to reach your endpoint in a time window.	`/api/v1/trigger-delivery/endpoints/{endpoint_id}:recover`	Resend every event that failed to reach your endpoint in a time window.	Python
GET	Get trigger activityBetaCount what happened to your environment's trigger events in the last 24 hours.	`/api/v1/trigger-activity`	Count what happened to your environment's trigger events in the last 24 hours.	Python
GET	Get trigger usageBetaGet the trigger deliveries metered for your environment, by hour or day.	`/api/v1/trigger-usage`	Get the trigger deliveries metered for your environment, by hour or day.	Python