> ## Documentation Index
> Fetch the complete documentation index at: https://docs.morf.health/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Completed Onboarding Item

> Event payload details and trigger documentation for Completed Onboarding Item data from Healthie

<img src="https://mintcdn.com/morfhealth/EU2WCxuXGIUQcziR/images/healthie.svg?fit=max&auto=format&n=EU2WCxuXGIUQcziR&q=85&s=d168a24dbae69f2202ca63dd7aa2e1f3" alt="images/healthie.svg" width="40" height="40" data-path="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`

<RequestExample>
  ```json Example theme={null}
  {
    "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"
  }
  ```
</RequestExample>

<ResponseExample>
  ```json Description theme={null}
  {
    "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)"
  }
  ```
</ResponseExample>

### Payload Field Details

<ResponseField name="Completed Onboarding Item" type="Event Payload">
  <Expandable title="fields" defaultOpen="true">
    <ResponseField name="id" type="string" required>
      Unique identifier for the completed onboarding item

      ```json CEL theme={null}
      id
      ```

      ```json Example theme={null}
      "123456"
      ```
    </ResponseField>

    <ResponseField name="item_id" type="string">
      ID of the associated onboarding item

      ```json CEL theme={null}
      item_id
      ```

      ```json Example theme={null}
      "789012"
      ```
    </ResponseField>

    <ResponseField name="item_type" type="string">
      The type of item that was completed

      ```json CEL theme={null}
      item_type
      ```

      ```json Example theme={null}
      "CustomModuleForm"
      ```
    </ResponseField>

    <ResponseField name="onboarding_item" type="object">
      The onboarding item that was completed

      ```json CEL theme={null}
      onboarding_item
      ```

      ```json Example theme={null}
      {
      "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"
      }
      ```
    </ResponseField>

    <ResponseField name="onboarding_item.id" type="string">
      Unique identifier for the onboarding item

      ```json CEL theme={null}
      onboarding_item.id
      ```

      ```json Example theme={null}
      "456789"
      ```
    </ResponseField>

    <ResponseField name="onboarding_item.item_id" type="string">
      Secondary identifier for the onboarding item

      ```json CEL theme={null}
      onboarding_item.item_id
      ```

      ```json Example theme={null}
      "345678"
      ```
    </ResponseField>

    <ResponseField name="onboarding_item.display_name" type="string">
      Display name of the onboarding item

      ```json CEL theme={null}
      onboarding_item.display_name
      ```

      ```json Example theme={null}
      "Complete Initial Assessment"
      ```
    </ResponseField>

    <ResponseField name="onboarding_item.incomplete_custom_module_form_id" type="string">
      ID of the custom module form that needs to be completed

      ```json CEL theme={null}
      onboarding_item.incomplete_custom_module_form_id
      ```

      ```json Example theme={null}
      "234567"
      ```
    </ResponseField>

    <ResponseField name="onboarding_item.is_last_item" type="bool">
      Indicates if this is the last item in the onboarding flow

      ```json CEL theme={null}
      onboarding_item.is_last_item
      ```

      ```json Example theme={null}
      false
      ```
    </ResponseField>

    <ResponseField name="onboarding_item.completed_onboarding_item" type="object">
      Information about the completion status of this item

      ```json CEL theme={null}
      onboarding_item.completed_onboarding_item
      ```

      ```json Example theme={null}
      {
      "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"
      }
      ```
    </ResponseField>

    <ResponseField name="onboarding_item.completed_form_id" type="string">
      ID of the form used for completion

      ```json CEL theme={null}
      onboarding_item.completed_form_id
      ```

      ```json Example theme={null}
      "123456"
      ```
    </ResponseField>

    <ResponseField name="skipped" type="bool" required>
      Set to true if the user skipped this item

      ```json CEL theme={null}
      skipped
      ```

      ```json Example theme={null}
      false
      ```
    </ResponseField>

    <ResponseField name="user_id" type="string">
      The ID of the completer (client)

      ```json CEL theme={null}
      user_id
      ```

      ```json Example theme={null}
      "345678"
      ```
    </ResponseField>
  </Expandable>
</ResponseField>