Webhooks
Form submitted webhook payload
- json
01{02 "activity_id": "<ACTIVITY_ID>",03 "date": "<FORM_SUBMISSION_DATE>",04 "response": [05 {06 "id": "<DATA_POINT_ID>",07 "data_point_definition_id": "<DATA_POINT_DEFINITION_ID>",08 "valueType": "boolean / string / number / date / numbers_array",09 "value": "<DATA_POINT_VALUE>",10 "data_set_id": "<PATHWAY_ID>",11 "date": "<COLLECTION_DATE>" // In ISO8601 format12 },13 {...}14 ],15 "form": {16 "title": "<FORM_TITLE>",17 "questions": [18 {19 "title": "<QUESTION_TITLE>",20 "key": "<QUESTION_KEY>",21 "definition_id": "<QUESTION_DEFINITION_ID>",22 "questionType": "input / no_input / multiple_choice",23 "userQuestionType": "<See UserQuestionType enum below>",24 "titleHtml": "<QUESTION_TITLE_IN_HTML>", // Question title as HTML; only populated for Description userQuestionType25 }26 ]27 },28 "pathway": {29 "id": "<PATHWAY_ID>",30 "pathway_definition_id": "<PATHWAY_DEFINITION_ID>",31 "patient_id": "<PATIENT_ID>",32 "start_date": "<PATHWAY_START_DATE>" // In ISO8601 format33 },34 "event_type": "form.submitted"35}
- typescript
01enum UserQuestionType {02 MULTIPLE_SELECT = 'multiple_select',03 MULTIPLE_CHOICE = 'multiple_choice',04 NUMBER = 'number',05 YES_NO = 'yes_no',06 DATE = 'date',07 SHORT_TEXT = 'short_text',08 LONG_TEXT = 'long_text',09 SLIDER = 'slider',10 DESCRIPTION = 'description',11 MULTIPLE_CHOICE_GRID = 'multiple_choice_grid',12 SIGNATURE = 'signature',13 TELEPHONE = 'telephone',14}