Awell Health Developer Hub
Developer Hub

This request allows us to complete a checklist. We do not track the completion of individual checklist items, only that the checklist has been completed so that we can continue orchestrating the pathway.

Request

Mutation

  • graphql
01mutation SubmitChecklist($input: SubmitChecklistInput!) {
02 submitChecklist(input: $input) {
03 activity {
04 id
05 status
06 }
07 }
08}

Variables

  • json
01{
02 "input": {
03 "activity_id": {{CHECKLIST_ID}}
04 }
05}

Specifying the user

The optional X-User-ID header can be used to specify which user has completed the checklist. When this header is present, Awell Orchestration will log a subactivity indicating that this specific user completed the checklist.

  • json
01{
02 "X-User-ID": "{{USER_ID}}"
03}

The following input fields are available:

FieldRequiredDescriptionType
activity_idYesthe id of the checklist activitystring