Webhooks

We also make webhooks available if you would prefer to get certain events

For now, if you’d like to use our webhook interface, please get in touch with your point of contact, and we will help you get your endpoint registered in our system.

Webhook interface

High-level, we will send you a POST request to the endpoint you provide.

Currently, we only support providing Milestone updates (e.g., when a milestone changes due to progress on the work). We may expand this in the future.

These are sent as an Event. You can determine the type of object to process, embedded in the Event, via the object key.

Example response:

{
  "code": 0,
  "type": "milestone.updated",
  "object": "milestone",
  "data": {
    "object": {
      "milestone_id": 3958,
      "project_id": 1022,
      "name": "Inspect Materials",
      "payment_status": 0,
      "total_cost": 1000,
      "scheduled_at": 1713454102,
      "due_at": 1713454102,
      "started_at": 1713454102,
      "updated_at": 1713454102,
      "completed_at": 1713454102,
      "assigned_service_provider": "service_provider@dev.null"
    }
  }
}