Skip to main content
images/healthie.svg

Events

Triggering Webhook Types

The following event types are associated with the Completed Onboarding Item event payload from Healthie.
  • Healthie Completed Onboarding Item Created
  • Healthie Completed Onboarding Item Updated
{
  "id": "123456",
  "item_id": "789012",
  "item_type": "CustomModuleForm",
  "onboarding_item": {
    "completed_form_id": "123456",
    "completed_onboarding_item": null,
    "display_name": "Complete Initial Assessment",
    "id": "456789",
    "incomplete_custom_module_form_id": "234567",
    "is_last_item": false,
    "item_id": "345678"
  },
  "skipped": false,
  "user_id": "345678"
}
{
  "id": "Unique identifier for the completed onboarding item",
  "item_id": "ID of the associated onboarding item",
  "item_type": "The type of item that was completed",
  "onboarding_item": {
    "completed_form_id": "ID of the form used for completion",
    "completed_onboarding_item": null,
    "display_name": "Display name of the onboarding item",
    "id": "Unique identifier for the onboarding item",
    "incomplete_custom_module_form_id": "ID of the custom module form that needs to be completed",
    "is_last_item": "Indicates if this is the last item in the onboarding flow",
    "item_id": "Secondary identifier for the onboarding item"
  },
  "skipped": "Set to true if the user skipped this item",
  "user_id": "The ID of the completer (client)"
}

Payload Field Details

Completed Onboarding Item
Event Payload