Events
Triggering Webhook Types
The following event types are associated with the Completed Onboarding Item event payload from Healthie.Healthie Completed Onboarding Item CreatedHealthie 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
Hide fields
Hide fields
Unique identifier for the completed onboarding item
CEL
id
Example
"123456"
ID of the associated onboarding item
CEL
item_id
Example
"789012"
The type of item that was completed
CEL
item_type
Example
"CustomModuleForm"
The onboarding item that was completed
CEL
onboarding_item
Example
{
"completed_form_id": "123456",
"completed_onboarding_item": {
"id": "123456",
"item_id": "789012",
"item_type": "CustomModuleForm",
"onboarding_item": null,
"skipped": false,
"user_id": "345678"
},
"display_name": "Complete Initial Assessment",
"id": "456789",
"incomplete_custom_module_form_id": "234567",
"is_last_item": false,
"item_id": "345678"
}
Unique identifier for the onboarding item
CEL
onboarding_item.id
Example
"456789"
Secondary identifier for the onboarding item
CEL
onboarding_item.item_id
Example
"345678"
Display name of the onboarding item
CEL
onboarding_item.display_name
Example
"Complete Initial Assessment"
ID of the custom module form that needs to be completed
CEL
onboarding_item.incomplete_custom_module_form_id
Example
"234567"
Indicates if this is the last item in the onboarding flow
CEL
onboarding_item.is_last_item
Example
false
Information about the completion status of this item
CEL
onboarding_item.completed_onboarding_item
Example
{
"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 of the form used for completion
CEL
onboarding_item.completed_form_id
Example
"123456"
Set to true if the user skipped this item
CEL
skipped
Example
false
The ID of the completer (client)
CEL
user_id
Example
"345678"
