Docs
  • Solver
  • Models
    • Field Service Routing
    • Employee Shift Scheduling
  • Platform
Try models
  • Timefold Platform
  • API integration
  • Webhooks

Timefold Platform

    • Introduction
    • Planning AI concepts
    • Getting started with the Timefold Platform
    • Platform concepts
    • Models
      • Model catalog and documentation
      • Model versions and maturity
      • Trialing Timefold models
    • How-tos
      • Interpreting model run results
      • Configuration parameters and profiles
      • Balancing different optimization goals
      • Searching and categorizing runs for auditability
      • Member management and roles
    • API integration
      • API usage
      • Webhooks
    • Changelog
    • Feature requests
    • Self-Hosted
      • Self-Hosted vs. Timefold Cloud Platform
      • Installation instructions
      • Maps service
      • Troubleshooting
    • Trust
      • Risk profile
      • Product security
      • Data security
      • Legal and privacy

Webhooks

Configuring a webhook

To receive near real-time updates when runs finish, go to your tenant’s Webhooks page.

  1. Click Add Webhook to create a new webhook.

  2. Enter the URL to receive event updates from your tenant.

  3. Accept the generated name or provide a name for the webhook.

webhook configuration

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.

The supported triggers are:

  • Successful run completed.

  • Run failed.

  • Runs with a name that matches a specific regular expression.

  • Runs that have the specified tags.

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
}

Retry strategy

Our platform expects the webhook URL to return HTTP Status Code 200. If the response code is different, we will try again 10 seconds later. We will retry up to 10 times.

  • © 2025 Timefold BV
  • Timefold.ai
  • Documentation
  • Changelog
  • Send feedback
  • Privacy
  • Legal
    • Light mode
    • Dark mode
    • System default