Establishing and using webhooks.
Webhooks are used to notify other applications of specific events or changes that occur in your Skedulo application in real-time.
Use the Skedulo Lens API to establish webhooks between the Skedulo application and your secure HTTPS API to implement specific event reactions.
For example, your application may need to be notified every time a new job is created, every time a job is updated with resource information, or every time a job status changes from
Skedulo also supports deferred webhooks and filtering, which means that you can configure your webhooks to fire if an object has a field equal to a specified value after a set period of time.
For example, you can configure a webhook to send a notification if the status of a job has not been changed to
Pending Dispatch within 24 hours of the job creation time.
- To use webhooks, or any other Skedulo Lens API, you must have an API access token obtained through the administrator settings in the Skedulo web application. The API token must be included in the
Authorizationheader using the
Environment variableThis documentation uses the
$AUTH_TOKENenvironment variable to represent the API token.
See Admin Settings: Developer Tools for more information about how to obtain an API token.
Only secure HTTPS URLs are accepted for Skedulo webhooks.
You must include
Content-Type: application/jsonin the API request header when creating a webhook.
Skedulo only supports GraphQL queries for webhooks. This makes it easy to see the data that is available and create queries that only return the data that you want to receive.
Defer a webhook or schedule a webhook to trigger at a specified time.
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.