Server sent events (SSE)

In production, we recommend configuring Webhooks to retrieve the solutions to your submitted datasets from Timefold.

In local development environments, we recommend using server sent events.

To subscribe to events for a submitted dataset, use the dataset ID from the response to the POST operation and make a GET request to the following endpoint:

/v1/{model-entity-name}/<ID>/events

  • Replace <ID> with the dataset ID.

  • For field service routing and pick-up and delivery routing, replace {model-entity-name} with route-plans.

  • For employee shift scheduling, replace {model-entity-name} with schedules.

The solverStatus can be in one several statuses. Solved datasets are final when the solverStatus is SOLVING_COMPLETED.

See Webhooks for more information.