Other webhooks

Workflow-triggered and survey webhook events.

Workflow triggered

This webhook can only be configured as an action inside a workflow. The payload carries the full employee record the workflow acts on.

{
  "data": {
    "id": 6369,
    "attributes": {
      "employee_number": null,
      "hired_on": "2017-08-21",
      "first_name": "Scott",
      "middle_name": "",
      "last_name": "Pilgrim",
      "email": "scott@example.com",
      "termination_effective_date": null,
      "termination_reason": null,
      "termination_type": null
    },
    "reporting_to": null,
    "position": null,
    "department": { "id": 105328, "name": "Corporate" },
    "division": null,
    "location": { "id": 3134, "name": "Spain" },
    "custom_fields": {
      "a25b06fb-bcfb-4aac-b695-6aff138fac36": { "name": "HR manager", "value": null, "group": "Personal" }
    },
    "meta": {
      "created_at": "2020-02-03T12:08:03.934+01:00",
      "updated_at": "2025-10-20T15:42:42.928+02:00"
    }
  }
}

Survey launched

Triggered instantly when a survey moves from "Scheduled" to "Running". Action: survey_start.

{
  "action": "survey_start",
  "data": {
    "id": 10441,
    "attributes": {
      "name": "Stress management",
      "state": "running",
      "locale": "en",
      "starts_at": "2024-02-01T00:00:00.000Z",
      "ends_at": "2024-02-29T00:00:00.000Z"
    },
    "meta": {
      "created_at": "2024-02-01T16:32:17.956Z",
      "updated_at": "2024-02-01T16:34:00.563Z"
    }
  }
}

On this page