Overview of triggered actions and webhooks
Webhooks are a way for you to listen for specific events or changes that occur to your Skedulo data. When a change occurs, you can configure webhooks to notify other applications or take actions in real-time. Triggered actions are Skedulo’s new iteration of webhooks and will eventually replace the legacy webhook functionality.
Webhooks and Triggered Actions are back-end configurations that instruct the Skedulo platform to perform an action when a data change or other event occurs.
Each configuration consists of a
URL, and a GraphQL query.
These configurations instruct the Skedulo platform to perform an action when a data change or other event occurs. Defined EQL filters limit the cases that generate an action. A filter is mandatory for triggered actions and optional (but strongly recommended) for webhooks.
Features and differentiators
Whether you use a webhook or a triggered action depends on your use case, as some features are only available using one implementation or the other.
|Include the previous data for a modified object.||❌||✅|
|Include the contents of a deleted object.||❌||✅|
|Query can retrieve extra data after a trigger is fired.||✅||❌|
|Trigger on inbound SMS (must be sent to the Skedulo-allocated customer SMS route number).||❌||✅|
|Send an SMS when triggered.||✅||❌|
|Execute after a time offset (deferred action).||✅||✅|
|Execute on a schedule (cron job).||❌||✅|
Authentication requirements for webhooks and triggered actions
- To use webhooks and triggered actions, or any other Skedulo Lens API, you must have an API access token, which can be obtained through the administrator settings in the Skedulo web application. The API token must be included in the
Authorizationheader using the
NoteThis documentation uses the
$AUTH_TOKENenvironment variable to represent the API token.
- Skedulo for Salesforce users must also have an API user configured for the Skedulo team (tenant). See Skedulo API user for more information.
- Only secure URLs (HTTPS) are accepted.
HTTP request headers
call_url triggered actions (see the triggered actions section for information on action types) set the following headers in their HTTP requests, depending on the context of the request:
|Always, if defined.||User-defined headers that are included in the configuration of the triggered action or webhook.|
|User-Agent||Always||Identifies the caller. Always set to “Skedulo”.||Skedulo|
|Skedulo-Triggeredactionlogid||Always||An ID that represents the specific request. Note that webhooks also have this header, since they are implemented as a triggered action.||41701066|
|Skedulo-Triggeredactionid||Triggered actions only||The ID of the triggered action configuration that caused the request. This will be the same every time this triggered action is executed.||
|Skedulo-Request-Id||Webhooks only||An ID that represents the specific request. Included for backward compatibility. The same value as Skedulo-Triggeredactionlogid||41701066|
|Skedulo-Webhook-Id||Webhooks only||The ID of the webhook configuration that caused the request. This will be the same every time this webhook is executed.||
Was this page helpful?