Webhooks
Configuring a webhook
To receive near real-time updates when runs finish:
-
Log into Timefold Platform and click on the dropdown at the top right next to your username.
-
Click on Tenant settings.
-
In the menu on the left hand side click Webhooks to access the webhooks configured for your tenant.
-
Click Add Webhook to create a new webhook.
-
Enter the URL to receive event updates from your tenant.
-
Accept the generated name or provide a name for the webhook.
Optionally, you can define http-headers that Timefold will send along with the webhook, for instance, to pass on an Authorization header.
Enable or disable the webhook with the toggle.
The webhook can be configured to trigger for different events.
If the webhook is always triggered, for each event we will send a POST call to the specified URL.
When webhooks trigger
The supported triggers are:
-
Successful run completed. (This includes when a run is cancelled.)
-
Run failed or incomplete.
-
Runs with a name that matches a specific regular expression.
-
Runs that have the specified tags.
Read more about Run lifecycle.
Webhook payload
Here is an example payload that will be sent to the webhook when a run has completed:
{
"id": "<the-id-of-the-run>",
"name": "<name of the run>",
"model": "field-service-routing",
"modelVersion": "v1",
"tags": [],
"status": "SOLVING_COMPLETED",
"runLink": "https://...", // Link to the API where you can fetch details about the run itself,
"outputLink": "https://..." // Link to the API where you can fetch the run's output
}