\n
title: Athena
\ndescription: Athena offers medical groups, hospitals, and health systems cloud-based EHR, practice management, and patient engagement services that seamlessly connect care and drive results for every client.
\nAthenahealth
\nAthena offers medical groups, hospitals, and health systems cloud-based EHR, practice management, and patient engagement services that seamlessly connect care and drive results for every client.
\nExtension settings
\nFor the extension to function correctly, you must configure the following settings:
\n- \n
- Auth server URL (e.g. https://api.preview.platform.athenahealth.com/oauth2/v1/token) \n
- Client ID \n
- Client secret \n
- API URL (https://api.preview.platform.athenahealth.com) \n
- Scope \n
- Practice ID \n
Actions
\nCreate patient
\nCreates a patient in athenahealth. First name, last name, date of birth, email, and department ID are required. If a patient with the same name, date of birth, and email already exists, a new patient record will not be created. Instead, the existing patient's ID will be returned.
\nGet patient
\nRetrieve the details of a given patient within a given practice.
\nGet appointment
\nRetrieve the details of an appointment.
\nCreate appointment note
\nCreate a note which will be appended to an appointment
","changelog":"Athena changelog
","actions":{"getPatient":{"key":"getPatient","title":"Get patient","description":"Retrieve patient details from Athena","category":"EHR Integrations","fields":{"patientId":{"id":"patientId","label":"Patient ID","description":"Logical identifier of the patient in Athena","type":"string","required":true}},"previewable":true,"dataPoints":{"firstName":{"key":"firstName","valueType":"string"},"lastName":{"key":"lastName","valueType":"string"},"email":{"key":"email","valueType":"string"},"dob":{"key":"dob","valueType":"date"}}},"getAppointment":{"key":"getAppointment","title":"Get appointment","description":"Retrieve appointment details from Athena","category":"EHR Integrations","fields":{"appointmentId":{"id":"appointmentId","label":"Appointment ID","description":"","type":"string","required":true}},"previewable":true,"dataPoints":{"patientId":{"key":"patientId","valueType":"string"},"startTime":{"key":"startTime","valueType":"string"},"status":{"key":"status","valueType":"string"},"appointmentTypeName":{"key":"appointmentTypeName","valueType":"string"},"appointmentTypeId":{"key":"appointmentTypeId","valueType":"string"},"date":{"key":"date","valueType":"date"},"duration":{"key":"duration","valueType":"number"}}},"createPatient":{"key":"createPatient","title":"Create patient","description":"Create a patient in athena","category":"EHR Integrations","fields":{"departmentid":{"id":"departmentid","label":"Department ID","description":"","type":"string","required":true},"firstname":{"id":"firstname","label":"First name","description":"","type":"string","required":true},"lastname":{"id":"lastname","label":"Last name","description":"","type":"string","required":true},"dob":{"id":"dob","label":"Date of birth","description":"","type":"date","required":true},"email":{"id":"email","label":"Email","description":"","type":"string","required":true}},"previewable":true,"dataPoints":{"createdPatientId":{"key":"createdPatientId","valueType":"string"}}},"createAppointmentNote":{"key":"createAppointmentNote","title":"Create appointment note","description":"Creates a note for a specific appointment","category":"EHR Integrations","fields":{"appointmentid":{"id":"appointmentid","label":"Appointment ID","description":"","type":"string","required":true},"notetext":{"id":"notetext","label":"Note text","description":"","type":"text","required":true},"displayonschedule":{"id":"displayonschedule","label":"Add note to homepage","description":"Add appointment note to homepage display","type":"boolean","required":false}},"previewable":true,"dataPoints":{}},"addClinicalDocument":{"key":"addClinicalDocument","title":"Add clinical document to chart","description":"Add clinical document to patient chart","category":"EHR Integrations","fields":{"departmentid":{"id":"departmentid","label":"Department ID","description":"","type":"string","required":true},"patientid":{"id":"patientid","label":"Patient ID","description":"","type":"string","required":true},"attachmentcontents":{"id":"attachmentcontents","label":"Content","description":"","type":"html","required":false}},"previewable":true,"dataPoints":{"clinicalDocumentId":{"key":"clinicalDocumentId","valueType":"string"}}}},"webhooks":[],"description":"Athena offers medical groups, hospitals, and health systems cloud-based EHR, practice management, and patient engagement services that seamlessly connect care and drive results for every client.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1708088411/Awell%20Extensions/athenahealth.png","title":"athenahealth","category":"EHR Integrations","author":{"authorType":"Awell"},"settings":{"auth_url":{"key":"auth_url","label":"Auth server URL","obfuscated":false,"required":true,"description":"Used to perform the Client Credential grant to obtain an access token"},"client_id":{"key":"client_id","label":"Client ID","obfuscated":true,"required":true,"description":"Used to perform the Client Credential grant to obtain an access token"},"client_secret":{"key":"client_secret","label":"Client secret","obfuscated":true,"required":true,"description":"Used to perform the Client Credential grant to obtain an access token"},"api_url":{"key":"api_url","label":"API URL","obfuscated":false,"required":true,"description":"The base URL of the resource server/API"},"scope":{"key":"scope","label":"Scope","obfuscated":false,"required":true,"description":"The value is a space-delimited, case-sensitive string of requested scopes."},"practiceId":{"key":"practiceId","label":"Practice ID","obfuscated":false,"required":true,"description":"The ID of your practice within athenahealth"}}},{"key":"availity","htmlDocs":"\n
title: Availity\ndescription: Availity's two-sided network allows payers and providers to share accurate, up-to-date information earlier in the healthcare lifecycle.
\n\n
Availity
\nAvaility's two-sided network allows payers and providers to share accurate, up-to-date information earlier in the healthcare lifecycle.
","changelog":"CHANGELOG
","actions":{"getInsuranceVerificationDemo":{"key":"getInsuranceVerificationDemo","title":"Get insurance verification (demo)","description":"This is a dummy action that either returns a verified or unverified status.","category":"Billing","fields":{},"previewable":true,"dataPoints":{"verified":{"key":"verified","valueType":"boolean"}}}},"webhooks":[],"description":"Availity's two-sided network allows payers and providers to share accurate, up-to-date information earlier in the healthcare lifecycle.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1752487435/Awell%20Extensions/availity.png","title":"Availity","category":"Billing","author":{"authorType":"Awell"},"settings":{}},{"key":"airtop","htmlDocs":"\n
title: Airtop
\ndescription: Effortlessly scrape and control any site with inexpensive and scalable AI-powered cloud browsers
\nAirtop
\nEffortlessly scrape and control any site with inexpensive and scalable AI-powered cloud browsers
\nExtension settings
\nTo set up this extension, you will need to provide your Airtop API key.
\nActions
\nSmart scrape
\nIntelligently scrape the full content of a page.
\nQuerying a page
\nInteract with a page using LLMs. Useful if you want to scrape a page for specific information, or even ask a more general question about the page. You can define an optional JSON schema to guide the AI’s response and force it to return JSON. This can be useful if you want a structured response that is more suitable for automated processing.
","changelog":"CHANGELOG
","actions":{"smartScrape":{"key":"smartScrape","title":"Smart Scrape a web page","description":"Scrape a web page with Airtop.","category":"Data","fields":{"pageUrl":{"id":"pageUrl","label":"Page URL","description":"The URL of the page to scrape","type":"string","required":true}},"previewable":true,"dataPoints":{"result":{"key":"result","valueType":"string"},"mimeType":{"key":"mimeType","valueType":"string"}}},"queryPage":{"key":"queryPage","title":"Query web page with LLM","description":"Query a web page using LLMs with Airtop’s.","category":"Data","fields":{"pageUrl":{"id":"pageUrl","label":"Page URL","description":"The URL of the page to scrape","type":"string","required":true},"prompt":{"id":"prompt","label":"Prompt","description":"The prompt used to query the page","type":"text","required":true},"jsonSchema":{"id":"jsonSchema","label":"JSON Schema","description":"Optional JSON schema to guide the AI’s response and force it to return JSON. This can be useful if you want a structured response that is more suitable for automated processing.","type":"json","required":false}},"previewable":true,"dataPoints":{"result":{"key":"result","valueType":"string"},"resultJson":{"key":"resultJson","valueType":"json"}}}},"webhooks":[],"description":"Effortlessly scrape and control any site with inexpensive and scalable AI-powered cloud browsers","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1754294899/Awell%20Extensions/1797e9c62ed74a4d95e8b9955abb6259.png","title":"Airtop","category":"Data","author":{"authorType":"Awell"},"settings":{"apiKey":{"key":"apiKey","label":"API key","description":"Your Airtop API key","required":true,"obfuscated":true}}},{"key":"awell","htmlDocs":"\n
title: Awell Workflow
\ndescription: Enrich your care flows with powerful Awell actions.
\nAwell API extension
\nExtension settings
\nYou will need to provide the API URL and an API key.
\nCustom Actions
\nStart care flow
\nStarts a new care flow for the patient enrolled in your current care flow.
\nPassing baseline info:\nPlease read the documentation on our developer hub to learn more about how to pass baseline info.
\nExample of how to configure a value for the baseline info action field:
\n[\n {\n \"data_point_definition_id\": \"age\",\n \"value\": \"29\"\n },\n {\n \"data_point_definition_id\": \"dob\",\n \"value\": \"1993-11-30\"\n }\n]\nStop care flow
\nStops the care flow the patient is currently enrolled in. A reason is why you are stopping the care flow is mandatory.
\nUpdate patient
\nAllows updating patient data for the patient currently enrolled in the care flow.
\nIs patient already enrolled in care flow
\nChecks whether the patient is already enrolled in a care flow definition. The care flow the patient is currently enrolled in does not count and is excluded from the results.
\nAction fields:
\n- \n
- pathwayStatus: a comma-separated string of care flow statuses that will be used when looking for care flows the patient is already enrolled in. By default, we only look at active care flows. Options: \"active\", \"completed\", \"missing_baseline_info\", \"starting\", and \"stopped\". \n
- careFlowDefinitionIds: a comma-separated string of care flow definition ids that will be used when looking for care flows the patient is already enrolled in. By default, we only search for care flows that match the current care flow definition id (i.e. is the patient already included in the current care flow?). \n
Data points:
\n- \n
- result: a boolean indicating whether the patient is already enrolled in another care flow that matches your criteria (status & care flow definition id) \n
- nbrOfResults: the number of care flows found for the patient that match the criteria. \n
- careFlowIds: a comma-separated string of care flow ids that matched your search criteria. It will be empty when the result is
falsebecause then there are no other care flow ids that match your criteria. \n
Search patients by patient code
\nNote that this action is deprecated and we recommend using identifiers instead.
\nSearch whether, apart from the patient currently enrolled in the care flow, another patient with the same patient_code already exists.
Data points:
\n- \n
- patientAlreadyExists: a boolean which will be true if minimum one patient with the patient code already exists. \n
- numberOfPatientsFound: the number of patients found with the same patient code. \n
- awellPatientIds: a comma-separated string of all Awell patient ids (except the current patient) that have the same patient code as the patient currently enrolled in the care flow. Will return an empty string when there are no other patients with the same patient code. \n
Get patient by identifier
\nThis action lets you check if a patient with a specific identifier already exists in Awell. It's particularly useful when a patient's identity is initially anonymous during the start of the care flow, but later becomes identifiable through the identifiers collected during the care flow. This check ensures whether a patient with that identifier is already present or not.
\nAdd identifier to patient
\nThis action allows you to add a unique identifier to the current patient's profile. If the patient already has an identifier with the same system but a different value, this action will update the existing identifier with the new value provided.
\nFirst, it checks if this identifier (system and value) is already associated with another patient. If it's safe to proceed, it will add or update the identifier as needed. However, if another patient already has this identifier, the action will stop and notify you, preventing duplicates. To avoid conflicts, we recommend first running the \"Get patient by identifier\" action to check for any existing matches.
\nGet data point value
\nThis action allows you to read the most recent data point value of a given data point definition id from a care flow different from the current one. The action returns multiple data points, each with a different value type. Pick the one you need from the returned data points based on the value type of the data point you want to read the value from.
\nExample:\nIf the data point you want to read the value from is of type number, then you should use the valueNumber data point.
Webhooks
\nWebhooks in the Awell extension offer ways to trigger a care flow based on the end of another care flow, or from any event that happens in your system (via the pathwayStart webhook).
","changelog":"Awell changelog
\nApril 2024
\nTwo new action were added: \"Get patient by identifier\" and \"Add identifier to patient\".
\nOctober 26, 2023
\nGeneric webhook to start a care flow added
\nApril 19, 2023
\nStop care flow action added.\nSearch patients by patient code action was added.\n\"Is patient enrolled in care flow\" action added.
","actions":{"addAdhocTrack":{"key":"addAdhocTrack","title":"Add ad hoc track","description":"Add a pre-configured ad hoc track to a patient care flow.","category":"Workflow","fields":{"trackId":{"id":"trackId","label":"Track ID","description":"The ID of the ad hoc track that you want to add to the patient care flow.","type":"string","required":true}},"previewable":false},"addIdentifierToPatient":{"key":"addIdentifierToPatient","title":"Add identifier to patient","description":"Add a new identifier to the patient's profile","category":"Workflow","fields":{"system":{"id":"system","label":"System","description":"The namespace for the identifier value","type":"string","required":true},"value":{"id":"value","label":"Identifier value","description":"The value of the identifier","type":"string","required":true}},"dataPoints":{},"previewable":false},"getPatientByIdentifier":{"key":"getPatientByIdentifier","title":"Get patient by identifier","description":"Retrieve a patient based on the provided identifier system and value","category":"Workflow","fields":{"system":{"id":"system","label":"System","description":"The namespace for the identifier value","type":"string","required":true},"value":{"id":"value","label":"Identifier value","description":"The value of the identifier","type":"string","required":true}},"dataPoints":{"patientAlreadyExists":{"key":"patientAlreadyExists","valueType":"boolean"},"patientId":{"key":"patientId","valueType":"string"}},"previewable":true},"startCareFlow":{"key":"startCareFlow","title":"Start care flow","description":"Start a new care flow for the patient currently enrolled in the care flow.","category":"Workflow","fields":{"pathwayDefinitionId":{"id":"pathwayDefinitionId","label":"Care flow definition ID","description":"The identifier of the care flow definition to start.","type":"string","required":true},"baselineInfo":{"id":"baselineInfo","label":"Baseline info","description":"Use baseline info to pass values for data points when starting a care flow. This needs to be an array of objects, please read the documentation for more info.","type":"json","required":false}},"dataPoints":{"careFlowId":{"key":"careFlowId","valueType":"string"}},"previewable":false},"updatePatient":{"key":"updatePatient","title":"Update patient","description":"Update the current patient with new data.","category":"Workflow","fields":{"patientCode":{"id":"patientCode","label":"Patient code","type":"string","required":false},"firstName":{"id":"firstName","label":"First name","type":"string","required":false},"lastName":{"id":"lastName","label":"Last name","type":"string","required":false},"email":{"id":"email","label":"Email","type":"string","required":false},"birthDate":{"id":"birthDate","label":"Birth date","type":"date","required":false},"mobilePhone":{"id":"mobilePhone","label":"Mobile phone","type":"string","stringType":"phone","required":false},"phone":{"id":"phone","label":"Phone","type":"string","stringType":"phone","required":false},"preferredLanguage":{"id":"preferredLanguage","label":"Preferred language","type":"string","required":false},"sex":{"id":"sex","label":"Sex","description":"Sex code as defined by ISO standard IEC_5218","type":"string","required":false,"options":{"dropdownOptions":[{"label":"FEMALE","value":"FEMALE"},{"label":"MALE","value":"MALE"},{"label":"NOT_KNOWN","value":"NOT_KNOWN"}]}},"city":{"id":"city","label":"City","type":"string","required":false},"country":{"id":"country","label":"Country","type":"string","required":false},"state":{"id":"state","label":"State","type":"string","required":false},"street":{"id":"street","label":"Street","type":"string","required":false},"zip":{"id":"zip","label":"ZIP","type":"string","required":false},"nationalRegistryNumber":{"id":"nationalRegistryNumber","label":"National registry number","type":"string","required":false},"patientTimzone":{"id":"patientTimzone","label":"Patient timezone","type":"string","required":false,"options":{"dropdownOptions":[{"label":"Africa/Algiers","value":"Africa/Algiers"},{"label":"Atlantic/Cape_Verde","value":"Atlantic/Cape_Verde"},{"label":"Africa/Ndjamena","value":"Africa/Ndjamena"},{"label":"Africa/Abidjan","value":"Africa/Abidjan"},{"label":"Africa/Cairo","value":"Africa/Cairo"},{"label":"Africa/Bissau","value":"Africa/Bissau"},{"label":"Africa/Nairobi","value":"Africa/Nairobi"},{"label":"Africa/Monrovia","value":"Africa/Monrovia"},{"label":"Africa/Tripoli","value":"Africa/Tripoli"},{"label":"Indian/Mauritius","value":"Indian/Mauritius"},{"label":"Africa/Casablanca","value":"Africa/Casablanca"},{"label":"Africa/El_Aaiun","value":"Africa/El_Aaiun"},{"label":"Africa/Maputo","value":"Africa/Maputo"},{"label":"Africa/Windhoek","value":"Africa/Windhoek"},{"label":"Africa/Lagos","value":"Africa/Lagos"},{"label":"Africa/Sao_Tome","value":"Africa/Sao_Tome"},{"label":"Africa/Johannesburg","value":"Africa/Johannesburg"},{"label":"Africa/Khartoum","value":"Africa/Khartoum"},{"label":"Africa/Juba","value":"Africa/Juba"},{"label":"Africa/Tunis","value":"Africa/Tunis"},{"label":"Antarctica/Casey","value":"Antarctica/Casey"},{"label":"Antarctica/Davis","value":"Antarctica/Davis"},{"label":"Antarctica/Mawson","value":"Antarctica/Mawson"},{"label":"Antarctica/Troll","value":"Antarctica/Troll"},{"label":"Antarctica/Vostok","value":"Antarctica/Vostok"},{"label":"Antarctica/Rothera","value":"Antarctica/Rothera"},{"label":"Asia/Kabul","value":"Asia/Kabul"},{"label":"Asia/Yerevan","value":"Asia/Yerevan"},{"label":"Asia/Baku","value":"Asia/Baku"},{"label":"Asia/Dhaka","value":"Asia/Dhaka"},{"label":"Asia/Thimphu","value":"Asia/Thimphu"},{"label":"Indian/Chagos","value":"Indian/Chagos"},{"label":"Asia/Yangon","value":"Asia/Yangon"},{"label":"Asia/Shanghai","value":"Asia/Shanghai"},{"label":"Asia/Urumqi","value":"Asia/Urumqi"},{"label":"Asia/Hong_Kong","value":"Asia/Hong_Kong"},{"label":"Asia/Taipei","value":"Asia/Taipei"},{"label":"Asia/Macau","value":"Asia/Macau"},{"label":"Asia/Nicosia","value":"Asia/Nicosia"},{"label":"Asia/Famagusta","value":"Asia/Famagusta"},{"label":"Asia/Tbilisi","value":"Asia/Tbilisi"},{"label":"Asia/Dili","value":"Asia/Dili"},{"label":"Asia/Kolkata","value":"Asia/Kolkata"},{"label":"Asia/Jakarta","value":"Asia/Jakarta"},{"label":"Asia/Pontianak","value":"Asia/Pontianak"},{"label":"Asia/Makassar","value":"Asia/Makassar"},{"label":"Asia/Jayapura","value":"Asia/Jayapura"},{"label":"Asia/Tehran","value":"Asia/Tehran"},{"label":"Asia/Baghdad","value":"Asia/Baghdad"},{"label":"Asia/Jerusalem","value":"Asia/Jerusalem"},{"label":"Asia/Tokyo","value":"Asia/Tokyo"},{"label":"Asia/Amman","value":"Asia/Amman"},{"label":"Asia/Almaty","value":"Asia/Almaty"},{"label":"Asia/Qyzylorda","value":"Asia/Qyzylorda"},{"label":"Asia/Qostanay","value":"Asia/Qostanay"},{"label":"Asia/Aqtobe","value":"Asia/Aqtobe"},{"label":"Asia/Aqtau","value":"Asia/Aqtau"},{"label":"Asia/Atyrau","value":"Asia/Atyrau"},{"label":"Asia/Oral","value":"Asia/Oral"},{"label":"Asia/Bishkek","value":"Asia/Bishkek"},{"label":"Asia/Seoul","value":"Asia/Seoul"},{"label":"Asia/Pyongyang","value":"Asia/Pyongyang"},{"label":"Asia/Beirut","value":"Asia/Beirut"},{"label":"Asia/Kuching","value":"Asia/Kuching"},{"label":"Indian/Maldives","value":"Indian/Maldives"},{"label":"Asia/Hovd","value":"Asia/Hovd"},{"label":"Asia/Ulaanbaatar","value":"Asia/Ulaanbaatar"},{"label":"Asia/Kathmandu","value":"Asia/Kathmandu"},{"label":"Asia/Karachi","value":"Asia/Karachi"},{"label":"Asia/Gaza","value":"Asia/Gaza"},{"label":"Asia/Hebron","value":"Asia/Hebron"},{"label":"Asia/Manila","value":"Asia/Manila"},{"label":"Asia/Qatar","value":"Asia/Qatar"},{"label":"Asia/Riyadh","value":"Asia/Riyadh"},{"label":"Asia/Singapore","value":"Asia/Singapore"},{"label":"Asia/Colombo","value":"Asia/Colombo"},{"label":"Asia/Damascus","value":"Asia/Damascus"},{"label":"Asia/Dushanbe","value":"Asia/Dushanbe"},{"label":"Asia/Bangkok","value":"Asia/Bangkok"},{"label":"Asia/Ashgabat","value":"Asia/Ashgabat"},{"label":"Asia/Dubai","value":"Asia/Dubai"},{"label":"Asia/Samarkand","value":"Asia/Samarkand"},{"label":"Asia/Tashkent","value":"Asia/Tashkent"},{"label":"Asia/Ho_Chi_Minh","value":"Asia/Ho_Chi_Minh"},{"label":"Australia/Darwin","value":"Australia/Darwin"},{"label":"Australia/Perth","value":"Australia/Perth"},{"label":"Australia/Eucla","value":"Australia/Eucla"},{"label":"Australia/Brisbane","value":"Australia/Brisbane"},{"label":"Australia/Lindeman","value":"Australia/Lindeman"},{"label":"Australia/Adelaide","value":"Australia/Adelaide"},{"label":"Australia/Hobart","value":"Australia/Hobart"},{"label":"Australia/Melbourne","value":"Australia/Melbourne"},{"label":"Australia/Sydney","value":"Australia/Sydney"},{"label":"Australia/Broken_Hill","value":"Australia/Broken_Hill"},{"label":"Australia/Lord_Howe","value":"Australia/Lord_Howe"},{"label":"Antarctica/Macquarie","value":"Antarctica/Macquarie"},{"label":"Pacific/Fiji","value":"Pacific/Fiji"},{"label":"Pacific/Gambier","value":"Pacific/Gambier"},{"label":"Pacific/Marquesas","value":"Pacific/Marquesas"},{"label":"Pacific/Tahiti","value":"Pacific/Tahiti"},{"label":"Pacific/Guam","value":"Pacific/Guam"},{"label":"Pacific/Tarawa","value":"Pacific/Tarawa"},{"label":"Pacific/Kanton","value":"Pacific/Kanton"},{"label":"Pacific/Kiritimati","value":"Pacific/Kiritimati"},{"label":"Pacific/Kwajalein","value":"Pacific/Kwajalein"},{"label":"Pacific/Kosrae","value":"Pacific/Kosrae"},{"label":"Pacific/Nauru","value":"Pacific/Nauru"},{"label":"Pacific/Noumea","value":"Pacific/Noumea"},{"label":"Pacific/Auckland","value":"Pacific/Auckland"},{"label":"Pacific/Chatham","value":"Pacific/Chatham"},{"label":"Pacific/Rarotonga","value":"Pacific/Rarotonga"},{"label":"Pacific/Niue","value":"Pacific/Niue"},{"label":"Pacific/Norfolk","value":"Pacific/Norfolk"},{"label":"Pacific/Palau","value":"Pacific/Palau"},{"label":"Pacific/Port_Moresby","value":"Pacific/Port_Moresby"},{"label":"Pacific/Bougainville","value":"Pacific/Bougainville"},{"label":"Pacific/Pitcairn","value":"Pacific/Pitcairn"},{"label":"Pacific/Pago_Pago","value":"Pacific/Pago_Pago"},{"label":"Pacific/Apia","value":"Pacific/Apia"},{"label":"Pacific/Guadalcanal","value":"Pacific/Guadalcanal"},{"label":"Pacific/Fakaofo","value":"Pacific/Fakaofo"},{"label":"Pacific/Tongatapu","value":"Pacific/Tongatapu"},{"label":"Pacific/Efate","value":"Pacific/Efate"},{"label":"Australia/ACT","value":"Australia/ACT"},{"label":"Australia/LHI","value":"Australia/LHI"},{"label":"Australia/NSW","value":"Australia/NSW"},{"label":"Australia/North","value":"Australia/North"},{"label":"Australia/Queensland","value":"Australia/Queensland"},{"label":"Australia/South","value":"Australia/South"},{"label":"Australia/Tasmania","value":"Australia/Tasmania"},{"label":"Australia/Victoria","value":"Australia/Victoria"},{"label":"Australia/West","value":"Australia/West"},{"label":"Australia/Yancowinna","value":"Australia/Yancowinna"},{"label":"Brazil/Acre","value":"Brazil/Acre"},{"label":"Brazil/DeNoronha","value":"Brazil/DeNoronha"},{"label":"Brazil/East","value":"Brazil/East"},{"label":"Brazil/West","value":"Brazil/West"},{"label":"CET","value":"CET"},{"label":"CST6CDT","value":"CST6CDT"},{"label":"Canada/Atlantic","value":"Canada/Atlantic"},{"label":"Canada/Central","value":"Canada/Central"},{"label":"Canada/Eastern","value":"Canada/Eastern"},{"label":"Canada/Mountain","value":"Canada/Mountain"},{"label":"Canada/Newfoundland","value":"Canada/Newfoundland"},{"label":"Canada/Pacific","value":"Canada/Pacific"},{"label":"Canada/Saskatchewan","value":"Canada/Saskatchewan"},{"label":"Canada/Yukon","value":"Canada/Yukon"},{"label":"Chile/Continental","value":"Chile/Continental"},{"label":"Chile/EasterIsland","value":"Chile/EasterIsland"},{"label":"Cuba","value":"Cuba"},{"label":"EET","value":"EET"},{"label":"EST","value":"EST"},{"label":"EST5EDT","value":"EST5EDT"},{"label":"Egypt","value":"Egypt"},{"label":"Eire","value":"Eire"},{"label":"Etc/GMT+0","value":"Etc/GMT+0"},{"label":"Etc/GMT-0","value":"Etc/GMT-0"},{"label":"Etc/GMT0","value":"Etc/GMT0"},{"label":"Etc/Greenwich","value":"Etc/Greenwich"},{"label":"Etc/UCT","value":"Etc/UCT"},{"label":"Etc/Universal","value":"Etc/Universal"},{"label":"Etc/Zulu","value":"Etc/Zulu"},{"label":"GB","value":"GB"},{"label":"GB-Eire","value":"GB-Eire"},{"label":"GMT+0","value":"GMT+0"},{"label":"GMT-0","value":"GMT-0"},{"label":"GMT0","value":"GMT0"},{"label":"Greenwich","value":"Greenwich"},{"label":"Hongkong","value":"Hongkong"},{"label":"Iceland","value":"Iceland"},{"label":"Iran","value":"Iran"},{"label":"Israel","value":"Israel"},{"label":"Jamaica","value":"Jamaica"},{"label":"Japan","value":"Japan"},{"label":"Kwajalein","value":"Kwajalein"},{"label":"Libya","value":"Libya"},{"label":"MET","value":"MET"},{"label":"MST","value":"MST"},{"label":"MST7MDT","value":"MST7MDT"},{"label":"Mexico/BajaNorte","value":"Mexico/BajaNorte"},{"label":"Mexico/BajaSur","value":"Mexico/BajaSur"},{"label":"Mexico/General","value":"Mexico/General"},{"label":"NZ","value":"NZ"},{"label":"NZ-CHAT","value":"NZ-CHAT"},{"label":"Navajo","value":"Navajo"},{"label":"PRC","value":"PRC"},{"label":"Poland","value":"Poland"},{"label":"Portugal","value":"Portugal"},{"label":"ROC","value":"ROC"},{"label":"ROK","value":"ROK"},{"label":"Singapore","value":"Singapore"},{"label":"Turkey","value":"Turkey"},{"label":"UCT","value":"UCT"},{"label":"US/Alaska","value":"US/Alaska"},{"label":"US/Aleutian","value":"US/Aleutian"},{"label":"US/Arizona","value":"US/Arizona"},{"label":"US/Central","value":"US/Central"},{"label":"US/East-Indiana","value":"US/East-Indiana"},{"label":"US/Eastern","value":"US/Eastern"},{"label":"US/Hawaii","value":"US/Hawaii"},{"label":"US/Indiana-Starke","value":"US/Indiana-Starke"},{"label":"US/Michigan","value":"US/Michigan"},{"label":"US/Mountain","value":"US/Mountain"},{"label":"US/Pacific","value":"US/Pacific"},{"label":"US/Samoa","value":"US/Samoa"},{"label":"UTC","value":"UTC"},{"label":"Universal","value":"Universal"},{"label":"W-SU","value":"W-SU"},{"label":"Zulu","value":"Zulu"},{"label":"America/Buenos_Aires","value":"America/Buenos_Aires"},{"label":"America/Catamarca","value":"America/Catamarca"},{"label":"America/Cordoba","value":"America/Cordoba"},{"label":"America/Indianapolis","value":"America/Indianapolis"},{"label":"America/Jujuy","value":"America/Jujuy"},{"label":"America/Knox_IN","value":"America/Knox_IN"},{"label":"America/Louisville","value":"America/Louisville"},{"label":"America/Mendoza","value":"America/Mendoza"},{"label":"America/Virgin","value":"America/Virgin"},{"label":"Pacific/Samoa","value":"Pacific/Samoa"},{"label":"Africa/Accra","value":"Africa/Accra"},{"label":"Africa/Addis_Ababa","value":"Africa/Addis_Ababa"},{"label":"Africa/Asmara","value":"Africa/Asmara"},{"label":"Africa/Bamako","value":"Africa/Bamako"},{"label":"Africa/Bangui","value":"Africa/Bangui"},{"label":"Africa/Banjul","value":"Africa/Banjul"},{"label":"Africa/Blantyre","value":"Africa/Blantyre"},{"label":"Africa/Brazzaville","value":"Africa/Brazzaville"},{"label":"Africa/Bujumbura","value":"Africa/Bujumbura"},{"label":"Africa/Conakry","value":"Africa/Conakry"},{"label":"Africa/Dakar","value":"Africa/Dakar"},{"label":"Africa/Dar_es_Salaam","value":"Africa/Dar_es_Salaam"},{"label":"Africa/Djibouti","value":"Africa/Djibouti"},{"label":"Africa/Douala","value":"Africa/Douala"},{"label":"Africa/Freetown","value":"Africa/Freetown"},{"label":"Africa/Gaborone","value":"Africa/Gaborone"},{"label":"Africa/Harare","value":"Africa/Harare"},{"label":"Africa/Kampala","value":"Africa/Kampala"},{"label":"Africa/Kigali","value":"Africa/Kigali"},{"label":"Africa/Kinshasa","value":"Africa/Kinshasa"},{"label":"Africa/Libreville","value":"Africa/Libreville"},{"label":"Africa/Lome","value":"Africa/Lome"},{"label":"Africa/Luanda","value":"Africa/Luanda"},{"label":"Africa/Lubumbashi","value":"Africa/Lubumbashi"},{"label":"Africa/Lusaka","value":"Africa/Lusaka"},{"label":"Africa/Malabo","value":"Africa/Malabo"},{"label":"Africa/Maseru","value":"Africa/Maseru"},{"label":"Africa/Mbabane","value":"Africa/Mbabane"},{"label":"Africa/Mogadishu","value":"Africa/Mogadishu"},{"label":"Africa/Niamey","value":"Africa/Niamey"},{"label":"Africa/Nouakchott","value":"Africa/Nouakchott"},{"label":"Africa/Ouagadougou","value":"Africa/Ouagadougou"},{"label":"Africa/Porto-Novo","value":"Africa/Porto-Novo"},{"label":"America/Anguilla","value":"America/Anguilla"},{"label":"America/Antigua","value":"America/Antigua"},{"label":"America/Aruba","value":"America/Aruba"},{"label":"America/Atikokan","value":"America/Atikokan"},{"label":"America/Blanc-Sablon","value":"America/Blanc-Sablon"},{"label":"America/Cayman","value":"America/Cayman"},{"label":"America/Creston","value":"America/Creston"},{"label":"America/Curacao","value":"America/Curacao"},{"label":"America/Dominica","value":"America/Dominica"},{"label":"America/Grenada","value":"America/Grenada"},{"label":"America/Guadeloupe","value":"America/Guadeloupe"},{"label":"America/Kralendijk","value":"America/Kralendijk"},{"label":"America/Lower_Princes","value":"America/Lower_Princes"},{"label":"America/Marigot","value":"America/Marigot"},{"label":"America/Montserrat","value":"America/Montserrat"},{"label":"America/Nassau","value":"America/Nassau"},{"label":"America/Port_of_Spain","value":"America/Port_of_Spain"},{"label":"America/St_Barthelemy","value":"America/St_Barthelemy"},{"label":"America/St_Kitts","value":"America/St_Kitts"},{"label":"America/St_Lucia","value":"America/St_Lucia"},{"label":"America/St_Thomas","value":"America/St_Thomas"},{"label":"America/St_Vincent","value":"America/St_Vincent"},{"label":"America/Tortola","value":"America/Tortola"},{"label":"Antarctica/DumontDUrville","value":"Antarctica/DumontDUrville"},{"label":"Antarctica/McMurdo","value":"Antarctica/McMurdo"},{"label":"Antarctica/Syowa","value":"Antarctica/Syowa"},{"label":"Arctic/Longyearbyen","value":"Arctic/Longyearbyen"},{"label":"Asia/Aden","value":"Asia/Aden"},{"label":"Asia/Bahrain","value":"Asia/Bahrain"},{"label":"Asia/Brunei","value":"Asia/Brunei"},{"label":"Asia/Kuala_Lumpur","value":"Asia/Kuala_Lumpur"},{"label":"Asia/Kuwait","value":"Asia/Kuwait"},{"label":"Asia/Muscat","value":"Asia/Muscat"},{"label":"Asia/Phnom_Penh","value":"Asia/Phnom_Penh"},{"label":"Asia/Vientiane","value":"Asia/Vientiane"},{"label":"Atlantic/Reykjavik","value":"Atlantic/Reykjavik"},{"label":"Atlantic/St_Helena","value":"Atlantic/St_Helena"},{"label":"Europe/Amsterdam","value":"Europe/Amsterdam"},{"label":"Europe/Bratislava","value":"Europe/Bratislava"},{"label":"Europe/Busingen","value":"Europe/Busingen"},{"label":"Europe/Copenhagen","value":"Europe/Copenhagen"},{"label":"Europe/Guernsey","value":"Europe/Guernsey"},{"label":"Europe/Isle_of_Man","value":"Europe/Isle_of_Man"},{"label":"Europe/Jersey","value":"Europe/Jersey"},{"label":"Europe/Ljubljana","value":"Europe/Ljubljana"},{"label":"Europe/Luxembourg","value":"Europe/Luxembourg"},{"label":"Europe/Mariehamn","value":"Europe/Mariehamn"},{"label":"Europe/Monaco","value":"Europe/Monaco"},{"label":"Europe/Oslo","value":"Europe/Oslo"},{"label":"Europe/Podgorica","value":"Europe/Podgorica"},{"label":"Europe/San_Marino","value":"Europe/San_Marino"},{"label":"Europe/Sarajevo","value":"Europe/Sarajevo"},{"label":"Europe/Skopje","value":"Europe/Skopje"},{"label":"Europe/Stockholm","value":"Europe/Stockholm"},{"label":"Europe/Vaduz","value":"Europe/Vaduz"},{"label":"Europe/Vatican","value":"Europe/Vatican"},{"label":"Europe/Zagreb","value":"Europe/Zagreb"},{"label":"Indian/Antananarivo","value":"Indian/Antananarivo"},{"label":"Indian/Christmas","value":"Indian/Christmas"},{"label":"Indian/Cocos","value":"Indian/Cocos"},{"label":"Indian/Comoro","value":"Indian/Comoro"},{"label":"Indian/Kerguelen","value":"Indian/Kerguelen"},{"label":"Indian/Mahe","value":"Indian/Mahe"},{"label":"Indian/Mayotte","value":"Indian/Mayotte"},{"label":"Indian/Reunion","value":"Indian/Reunion"},{"label":"Pacific/Chuuk","value":"Pacific/Chuuk"},{"label":"Pacific/Funafuti","value":"Pacific/Funafuti"},{"label":"Pacific/Majuro","value":"Pacific/Majuro"},{"label":"Pacific/Midway","value":"Pacific/Midway"},{"label":"Pacific/Pohnpei","value":"Pacific/Pohnpei"},{"label":"Pacific/Saipan","value":"Pacific/Saipan"},{"label":"Pacific/Wake","value":"Pacific/Wake"},{"label":"Pacific/Wallis","value":"Pacific/Wallis"},{"label":"Africa/Timbuktu","value":"Africa/Timbuktu"},{"label":"America/Argentina/ComodRivadavia","value":"America/Argentina/ComodRivadavia"},{"label":"America/Atka","value":"America/Atka"},{"label":"America/Coral_Harbour","value":"America/Coral_Harbour"},{"label":"America/Ensenada","value":"America/Ensenada"},{"label":"America/Fort_Wayne","value":"America/Fort_Wayne"},{"label":"America/Montreal","value":"America/Montreal"},{"label":"America/Nipigon","value":"America/Nipigon"},{"label":"America/Pangnirtung","value":"America/Pangnirtung"},{"label":"America/Porto_Acre","value":"America/Porto_Acre"},{"label":"America/Rainy_River","value":"America/Rainy_River"},{"label":"America/Rosario","value":"America/Rosario"},{"label":"America/Santa_Isabel","value":"America/Santa_Isabel"},{"label":"America/Shiprock","value":"America/Shiprock"},{"label":"America/Thunder_Bay","value":"America/Thunder_Bay"},{"label":"America/Yellowknife","value":"America/Yellowknife"},{"label":"Antarctica/South_Pole","value":"Antarctica/South_Pole"},{"label":"Asia/Choibalsan","value":"Asia/Choibalsan"},{"label":"Asia/Chongqing","value":"Asia/Chongqing"},{"label":"Asia/Harbin","value":"Asia/Harbin"},{"label":"Asia/Kashgar","value":"Asia/Kashgar"},{"label":"Asia/Tel_Aviv","value":"Asia/Tel_Aviv"},{"label":"Atlantic/Jan_Mayen","value":"Atlantic/Jan_Mayen"},{"label":"Australia/Canberra","value":"Australia/Canberra"},{"label":"Australia/Currie","value":"Australia/Currie"},{"label":"Europe/Belfast","value":"Europe/Belfast"},{"label":"Europe/Tiraspol","value":"Europe/Tiraspol"},{"label":"Europe/Uzhgorod","value":"Europe/Uzhgorod"},{"label":"Europe/Zaporozhye","value":"Europe/Zaporozhye"},{"label":"Pacific/Enderbury","value":"Pacific/Enderbury"},{"label":"Pacific/Johnston","value":"Pacific/Johnston"},{"label":"Pacific/Yap","value":"Pacific/Yap"},{"label":"WET","value":"WET"},{"label":"Africa/Asmera","value":"Africa/Asmera"},{"label":"America/Godthab","value":"America/Godthab"},{"label":"Asia/Ashkhabad","value":"Asia/Ashkhabad"},{"label":"Asia/Calcutta","value":"Asia/Calcutta"},{"label":"Asia/Chungking","value":"Asia/Chungking"},{"label":"Asia/Dacca","value":"Asia/Dacca"},{"label":"Asia/Istanbul","value":"Asia/Istanbul"},{"label":"Asia/Katmandu","value":"Asia/Katmandu"},{"label":"Asia/Macao","value":"Asia/Macao"},{"label":"Asia/Rangoon","value":"Asia/Rangoon"},{"label":"Asia/Saigon","value":"Asia/Saigon"},{"label":"Asia/Thimbu","value":"Asia/Thimbu"},{"label":"Asia/Ujung_Pandang","value":"Asia/Ujung_Pandang"},{"label":"Asia/Ulan_Bator","value":"Asia/Ulan_Bator"},{"label":"Atlantic/Faeroe","value":"Atlantic/Faeroe"},{"label":"Europe/Kiev","value":"Europe/Kiev"},{"label":"Europe/Nicosia","value":"Europe/Nicosia"},{"label":"HST","value":"HST"},{"label":"PST8PDT","value":"PST8PDT"},{"label":"Pacific/Ponape","value":"Pacific/Ponape"},{"label":"Pacific/Truk","value":"Pacific/Truk"},{"label":"Etc/UTC","value":"Etc/UTC"},{"label":"Etc/GMT","value":"Etc/GMT"},{"label":"GMT","value":"GMT"},{"label":"Etc/GMT-14","value":"Etc/GMT-14"},{"label":"Etc/GMT-13","value":"Etc/GMT-13"},{"label":"Etc/GMT-12","value":"Etc/GMT-12"},{"label":"Etc/GMT-11","value":"Etc/GMT-11"},{"label":"Etc/GMT-10","value":"Etc/GMT-10"},{"label":"Etc/GMT-9","value":"Etc/GMT-9"},{"label":"Etc/GMT-8","value":"Etc/GMT-8"},{"label":"Etc/GMT-7","value":"Etc/GMT-7"},{"label":"Etc/GMT-6","value":"Etc/GMT-6"},{"label":"Etc/GMT-5","value":"Etc/GMT-5"},{"label":"Etc/GMT-4","value":"Etc/GMT-4"},{"label":"Etc/GMT-3","value":"Etc/GMT-3"},{"label":"Etc/GMT-2","value":"Etc/GMT-2"},{"label":"Etc/GMT-1","value":"Etc/GMT-1"},{"label":"Etc/GMT+1","value":"Etc/GMT+1"},{"label":"Etc/GMT+2","value":"Etc/GMT+2"},{"label":"Etc/GMT+3","value":"Etc/GMT+3"},{"label":"Etc/GMT+4","value":"Etc/GMT+4"},{"label":"Etc/GMT+5","value":"Etc/GMT+5"},{"label":"Etc/GMT+6","value":"Etc/GMT+6"},{"label":"Etc/GMT+7","value":"Etc/GMT+7"},{"label":"Etc/GMT+8","value":"Etc/GMT+8"},{"label":"Etc/GMT+9","value":"Etc/GMT+9"},{"label":"Etc/GMT+10","value":"Etc/GMT+10"},{"label":"Etc/GMT+11","value":"Etc/GMT+11"},{"label":"Etc/GMT+12","value":"Etc/GMT+12"},{"label":"Europe/London","value":"Europe/London"},{"label":"Europe/Dublin","value":"Europe/Dublin"},{"label":"Europe/Tirane","value":"Europe/Tirane"},{"label":"Europe/Andorra","value":"Europe/Andorra"},{"label":"Europe/Vienna","value":"Europe/Vienna"},{"label":"Europe/Minsk","value":"Europe/Minsk"},{"label":"Europe/Brussels","value":"Europe/Brussels"},{"label":"Europe/Sofia","value":"Europe/Sofia"},{"label":"Europe/Prague","value":"Europe/Prague"},{"label":"Atlantic/Faroe","value":"Atlantic/Faroe"},{"label":"America/Danmarkshavn","value":"America/Danmarkshavn"},{"label":"America/Scoresbysund","value":"America/Scoresbysund"},{"label":"America/Nuuk","value":"America/Nuuk"},{"label":"America/Thule","value":"America/Thule"},{"label":"Europe/Tallinn","value":"Europe/Tallinn"},{"label":"Europe/Helsinki","value":"Europe/Helsinki"},{"label":"Europe/Paris","value":"Europe/Paris"},{"label":"Europe/Berlin","value":"Europe/Berlin"},{"label":"Europe/Gibraltar","value":"Europe/Gibraltar"},{"label":"Europe/Athens","value":"Europe/Athens"},{"label":"Europe/Budapest","value":"Europe/Budapest"},{"label":"Europe/Rome","value":"Europe/Rome"},{"label":"Europe/Riga","value":"Europe/Riga"},{"label":"Europe/Vilnius","value":"Europe/Vilnius"},{"label":"Europe/Malta","value":"Europe/Malta"},{"label":"Europe/Chisinau","value":"Europe/Chisinau"},{"label":"Europe/Warsaw","value":"Europe/Warsaw"},{"label":"Europe/Lisbon","value":"Europe/Lisbon"},{"label":"Atlantic/Azores","value":"Atlantic/Azores"},{"label":"Atlantic/Madeira","value":"Atlantic/Madeira"},{"label":"Europe/Bucharest","value":"Europe/Bucharest"},{"label":"Europe/Kaliningrad","value":"Europe/Kaliningrad"},{"label":"Europe/Moscow","value":"Europe/Moscow"},{"label":"Europe/Simferopol","value":"Europe/Simferopol"},{"label":"Europe/Astrakhan","value":"Europe/Astrakhan"},{"label":"Europe/Volgograd","value":"Europe/Volgograd"},{"label":"Europe/Saratov","value":"Europe/Saratov"},{"label":"Europe/Kirov","value":"Europe/Kirov"},{"label":"Europe/Samara","value":"Europe/Samara"},{"label":"Europe/Ulyanovsk","value":"Europe/Ulyanovsk"},{"label":"Asia/Yekaterinburg","value":"Asia/Yekaterinburg"},{"label":"Asia/Omsk","value":"Asia/Omsk"},{"label":"Asia/Barnaul","value":"Asia/Barnaul"},{"label":"Asia/Novosibirsk","value":"Asia/Novosibirsk"},{"label":"Asia/Tomsk","value":"Asia/Tomsk"},{"label":"Asia/Novokuznetsk","value":"Asia/Novokuznetsk"},{"label":"Asia/Krasnoyarsk","value":"Asia/Krasnoyarsk"},{"label":"Asia/Irkutsk","value":"Asia/Irkutsk"},{"label":"Asia/Chita","value":"Asia/Chita"},{"label":"Asia/Yakutsk","value":"Asia/Yakutsk"},{"label":"Asia/Vladivostok","value":"Asia/Vladivostok"},{"label":"Asia/Khandyga","value":"Asia/Khandyga"},{"label":"Asia/Sakhalin","value":"Asia/Sakhalin"},{"label":"Asia/Magadan","value":"Asia/Magadan"},{"label":"Asia/Srednekolymsk","value":"Asia/Srednekolymsk"},{"label":"Asia/Ust-Nera","value":"Asia/Ust-Nera"},{"label":"Asia/Kamchatka","value":"Asia/Kamchatka"},{"label":"Asia/Anadyr","value":"Asia/Anadyr"},{"label":"Europe/Belgrade","value":"Europe/Belgrade"},{"label":"Europe/Madrid","value":"Europe/Madrid"},{"label":"Africa/Ceuta","value":"Africa/Ceuta"},{"label":"Atlantic/Canary","value":"Atlantic/Canary"},{"label":"Europe/Zurich","value":"Europe/Zurich"},{"label":"Europe/Istanbul","value":"Europe/Istanbul"},{"label":"Europe/Kyiv","value":"Europe/Kyiv"},{"label":"Factory","value":"Factory"},{"label":"America/New_York","value":"America/New_York"},{"label":"America/Chicago","value":"America/Chicago"},{"label":"America/North_Dakota/Center","value":"America/North_Dakota/Center"},{"label":"America/North_Dakota/New_Salem","value":"America/North_Dakota/New_Salem"},{"label":"America/North_Dakota/Beulah","value":"America/North_Dakota/Beulah"},{"label":"America/Denver","value":"America/Denver"},{"label":"America/Los_Angeles","value":"America/Los_Angeles"},{"label":"America/Juneau","value":"America/Juneau"},{"label":"America/Sitka","value":"America/Sitka"},{"label":"America/Metlakatla","value":"America/Metlakatla"},{"label":"America/Yakutat","value":"America/Yakutat"},{"label":"America/Anchorage","value":"America/Anchorage"},{"label":"America/Nome","value":"America/Nome"},{"label":"America/Adak","value":"America/Adak"},{"label":"Pacific/Honolulu","value":"Pacific/Honolulu"},{"label":"America/Phoenix","value":"America/Phoenix"},{"label":"America/Boise","value":"America/Boise"},{"label":"America/Indiana/Indianapolis","value":"America/Indiana/Indianapolis"},{"label":"America/Indiana/Marengo","value":"America/Indiana/Marengo"},{"label":"America/Indiana/Vincennes","value":"America/Indiana/Vincennes"},{"label":"America/Indiana/Tell_City","value":"America/Indiana/Tell_City"},{"label":"America/Indiana/Petersburg","value":"America/Indiana/Petersburg"},{"label":"America/Indiana/Knox","value":"America/Indiana/Knox"},{"label":"America/Indiana/Winamac","value":"America/Indiana/Winamac"},{"label":"America/Indiana/Vevay","value":"America/Indiana/Vevay"},{"label":"America/Kentucky/Louisville","value":"America/Kentucky/Louisville"},{"label":"America/Kentucky/Monticello","value":"America/Kentucky/Monticello"},{"label":"America/Detroit","value":"America/Detroit"},{"label":"America/Menominee","value":"America/Menominee"},{"label":"America/St_Johns","value":"America/St_Johns"},{"label":"America/Goose_Bay","value":"America/Goose_Bay"},{"label":"America/Halifax","value":"America/Halifax"},{"label":"America/Glace_Bay","value":"America/Glace_Bay"},{"label":"America/Moncton","value":"America/Moncton"},{"label":"America/Toronto","value":"America/Toronto"},{"label":"America/Winnipeg","value":"America/Winnipeg"},{"label":"America/Regina","value":"America/Regina"},{"label":"America/Swift_Current","value":"America/Swift_Current"},{"label":"America/Edmonton","value":"America/Edmonton"},{"label":"America/Vancouver","value":"America/Vancouver"},{"label":"America/Dawson_Creek","value":"America/Dawson_Creek"},{"label":"America/Fort_Nelson","value":"America/Fort_Nelson"},{"label":"America/Iqaluit","value":"America/Iqaluit"},{"label":"America/Resolute","value":"America/Resolute"},{"label":"America/Rankin_Inlet","value":"America/Rankin_Inlet"},{"label":"America/Cambridge_Bay","value":"America/Cambridge_Bay"},{"label":"America/Inuvik","value":"America/Inuvik"},{"label":"America/Whitehorse","value":"America/Whitehorse"},{"label":"America/Dawson","value":"America/Dawson"},{"label":"America/Cancun","value":"America/Cancun"},{"label":"America/Merida","value":"America/Merida"},{"label":"America/Matamoros","value":"America/Matamoros"},{"label":"America/Monterrey","value":"America/Monterrey"},{"label":"America/Mexico_City","value":"America/Mexico_City"},{"label":"America/Ciudad_Juarez","value":"America/Ciudad_Juarez"},{"label":"America/Ojinaga","value":"America/Ojinaga"},{"label":"America/Chihuahua","value":"America/Chihuahua"},{"label":"America/Hermosillo","value":"America/Hermosillo"},{"label":"America/Mazatlan","value":"America/Mazatlan"},{"label":"America/Bahia_Banderas","value":"America/Bahia_Banderas"},{"label":"America/Tijuana","value":"America/Tijuana"},{"label":"America/Barbados","value":"America/Barbados"},{"label":"America/Belize","value":"America/Belize"},{"label":"Atlantic/Bermuda","value":"Atlantic/Bermuda"},{"label":"America/Costa_Rica","value":"America/Costa_Rica"},{"label":"America/Havana","value":"America/Havana"},{"label":"America/Santo_Domingo","value":"America/Santo_Domingo"},{"label":"America/El_Salvador","value":"America/El_Salvador"},{"label":"America/Guatemala","value":"America/Guatemala"},{"label":"America/Port-au-Prince","value":"America/Port-au-Prince"},{"label":"America/Tegucigalpa","value":"America/Tegucigalpa"},{"label":"America/Jamaica","value":"America/Jamaica"},{"label":"America/Martinique","value":"America/Martinique"},{"label":"America/Managua","value":"America/Managua"},{"label":"America/Panama","value":"America/Panama"},{"label":"America/Puerto_Rico","value":"America/Puerto_Rico"},{"label":"America/Miquelon","value":"America/Miquelon"},{"label":"America/Grand_Turk","value":"America/Grand_Turk"},{"label":"America/Argentina/Buenos_Aires","value":"America/Argentina/Buenos_Aires"},{"label":"America/Argentina/Cordoba","value":"America/Argentina/Cordoba"},{"label":"America/Argentina/Salta","value":"America/Argentina/Salta"},{"label":"America/Argentina/Tucuman","value":"America/Argentina/Tucuman"},{"label":"America/Argentina/La_Rioja","value":"America/Argentina/La_Rioja"},{"label":"America/Argentina/San_Juan","value":"America/Argentina/San_Juan"},{"label":"America/Argentina/Jujuy","value":"America/Argentina/Jujuy"},{"label":"America/Argentina/Catamarca","value":"America/Argentina/Catamarca"},{"label":"America/Argentina/Mendoza","value":"America/Argentina/Mendoza"},{"label":"America/Argentina/San_Luis","value":"America/Argentina/San_Luis"},{"label":"America/Argentina/Rio_Gallegos","value":"America/Argentina/Rio_Gallegos"},{"label":"America/Argentina/Ushuaia","value":"America/Argentina/Ushuaia"},{"label":"America/La_Paz","value":"America/La_Paz"},{"label":"America/Noronha","value":"America/Noronha"},{"label":"America/Belem","value":"America/Belem"},{"label":"America/Santarem","value":"America/Santarem"},{"label":"America/Fortaleza","value":"America/Fortaleza"},{"label":"America/Recife","value":"America/Recife"},{"label":"America/Araguaina","value":"America/Araguaina"},{"label":"America/Maceio","value":"America/Maceio"},{"label":"America/Bahia","value":"America/Bahia"},{"label":"America/Sao_Paulo","value":"America/Sao_Paulo"},{"label":"America/Campo_Grande","value":"America/Campo_Grande"},{"label":"America/Cuiaba","value":"America/Cuiaba"},{"label":"America/Porto_Velho","value":"America/Porto_Velho"},{"label":"America/Boa_Vista","value":"America/Boa_Vista"},{"label":"America/Manaus","value":"America/Manaus"},{"label":"America/Eirunepe","value":"America/Eirunepe"},{"label":"America/Rio_Branco","value":"America/Rio_Branco"},{"label":"America/Santiago","value":"America/Santiago"},{"label":"America/Coyhaique","value":"America/Coyhaique"},{"label":"America/Punta_Arenas","value":"America/Punta_Arenas"},{"label":"Pacific/Easter","value":"Pacific/Easter"},{"label":"Antarctica/Palmer","value":"Antarctica/Palmer"},{"label":"America/Bogota","value":"America/Bogota"},{"label":"America/Guayaquil","value":"America/Guayaquil"},{"label":"Pacific/Galapagos","value":"Pacific/Galapagos"},{"label":"Atlantic/Stanley","value":"Atlantic/Stanley"},{"label":"America/Cayenne","value":"America/Cayenne"},{"label":"America/Guyana","value":"America/Guyana"},{"label":"America/Asuncion","value":"America/Asuncion"},{"label":"America/Lima","value":"America/Lima"},{"label":"Atlantic/South_Georgia","value":"Atlantic/South_Georgia"},{"label":"America/Paramaribo","value":"America/Paramaribo"},{"label":"America/Montevideo","value":"America/Montevideo"},{"label":"America/Caracas","value":"America/Caracas"}]}}},"previewable":false},"stopCareFlow":{"key":"stopCareFlow","title":"Stop care flow","description":"Stop the care flow the patient is currently enrolled.","category":"Workflow","fields":{"careFlowIds":{"id":"careFlowIds","label":"Care flow ID(s)","description":"The care flow ID(s) to stop. You can stop multiple care flows at once by separating the IDs with a comma. If not provided, the current care flow will be stopped.","type":"string","required":false},"reason":{"id":"reason","label":"Reason","description":"The reason why you want to stop the care flow.","type":"string","required":true}},"previewable":false},"stopTrack":{"key":"stopTrack","title":"Stop track","description":"Stop a track in a patient care flow (pathway).","category":"Workflow","fields":{"trackDefinitionId":{"id":"trackDefinitionId","label":"Track definition ID","description":"The definitionID of the track that you want to stop.","type":"string","required":true}},"previewable":false},"searchPatientsByPatientCode":{"key":"searchPatientsByPatientCode","title":"Search patient by patient code (DEPRECATED, USE IDENTIFIERS)","description":"Search whether the current patient already exists. Search happens based on the `patient_code` field which is taken from the patient's profile.","category":"Demo","fields":{},"dataPoints":{"patientAlreadyExists":{"key":"patientAlreadyExists","valueType":"boolean"},"numberOfPatientsFound":{"key":"numberOfPatientsFound","valueType":"number"},"awellPatientIds":{"key":"awellPatientIds","valueType":"string"}},"previewable":true},"isPatientEnrolledInCareFlow":{"key":"isPatientEnrolledInCareFlow","title":"Is patient already enrolled in care flow","description":"Checks whether the patient is already enrolled in the current care flow definition.","category":"Workflow","fields":{"pathwayStatus":{"id":"pathwayStatus","label":"Pathway status","description":"A comma-separated string of care flow statuses that will be used when looking for care flows the patient is already enrolled in. By default, we only look at active care flows. Possible values are: starting, active, stopped, completed, missing_baseline_info.","type":"string","required":false},"careFlowDefinitionIds":{"id":"careFlowDefinitionIds","label":"Care flow definition IDs","description":"A comma-separated string of care flow definition ids that will be used when looking for care flows the patient is already enrolled in. By default, we only search for care flows that match the current care flow definition id (i.e. is the patient already included in the current care flow?).","type":"string","required":false},"dayRange":{"id":"dayRange","label":"Past day range","description":"The number of days to look back for care flows that were started in the past, e.g last 30 days.","type":"numeric","required":false}},"dataPoints":{"result":{"key":"result","valueType":"boolean"},"nbrOfResults":{"key":"nbrOfResults","valueType":"number"},"careFlowIds":{"key":"careFlowIds","valueType":"string"}},"previewable":false},"isPatientEnrolledInTrack":{"key":"isPatientEnrolledInTrack","title":"Check patient track enrollment status","description":"Checks whether the patient is enrolled, has been enrolled, or is scheduled to be enrolled in a specific track. This is time-based and will return the status of the track at the time of the check.","category":"Workflow","fields":{"trackDefinitionId":{"id":"trackDefinitionId","label":"Track definition ID","description":"The definition ID of the track to check enrollment status for.","type":"string","required":true}},"dataPoints":{"has_been_enrolled_in_track":{"key":"has_been_enrolled_in_track","valueType":"boolean"},"is_enrolled_in_track":{"key":"is_enrolled_in_track","valueType":"boolean"},"track_is_scheduled":{"key":"track_is_scheduled","valueType":"boolean"},"next_track_scheduled_date":{"key":"next_track_scheduled_date","valueType":"date"}},"previewable":false},"updateBaselineInfo":{"key":"updateBaselineInfo","title":"Update Baseline Datapoints","description":"Update some (or all) of the baseline datapoints for the patient currently enrolled in the care flow.","category":"Workflow","fields":{"careflowId":{"id":"careflowId","label":"Care flow ID","description":"The ID of the care flow to update the baseline info for. When not provided, the baseline info will be updated for the current care flow.","type":"string","required":false},"baselineInfo":{"id":"baselineInfo","label":"Baseline info","description":"Use baseline data points often used to start a care flow. Example: \n [\n {\n \"data_point_definition_id\": \"age\",\n \"value\": \"29\"\n },\n {\n \"data_point_definition_id\": \"dob\",\n \"value\": \"1993-11-30\"\n }\n ]","type":"json","required":false}},"dataPoints":{"success":{"key":"success","valueType":"boolean"}},"previewable":false},"startHostedPagesSession":{"key":"startHostedPagesSession","title":"Start Hosted Pages Session","description":"Start a new Hosted Pages session for a given stakeholder","category":"Workflow","fields":{"careFlowId":{"id":"careFlowId","label":"Care flow ID","description":"The instance ID of the care flow to start a session for","type":"string","required":true},"stakeholder":{"id":"stakeholder","label":"Stakeholder","description":"The name of the stakeholder to start the session for","type":"string","required":true}},"dataPoints":{"sessionUrl":{"key":"sessionUrl","valueType":"string"}},"previewable":false},"startCareFlowAndSession":{"key":"startCareFlowAndSession","title":"Start Care flow and session","description":"Start a new care flow and immediately create a session","category":"Workflow","fields":{"careFlowDefinitionId":{"id":"careFlowDefinitionId","label":"Care flow definition ID","description":"The definition ID of the care flow to start","type":"string","required":true},"stakeholderDefinitionId":{"id":"stakeholderDefinitionId","label":"Stakeholder ","description":"The stakeholder to start the session for","type":"string","options":{"dropdownOptions":[{"value":"LGH3v741vUqm","label":"Physician"},{"value":"patient","label":"Patient"}]},"required":true},"baselineInfo":{"id":"baselineInfo","label":"Baseline info","description":"Use baseline info to pass values for data points when starting a care flow. This needs to be an array of objects, please read the documentation for more info.","type":"json","required":false}},"dataPoints":{"careFlowId":{"key":"careFlowId","valueType":"string"},"sessionUrl":{"key":"sessionUrl","valueType":"string"}},"previewable":false},"getDataPointValue":{"key":"getDataPointValue","title":"Get data point value","description":"Get the value of a data point","category":"Workflow","fields":{"careFlowId":{"id":"careFlowId","label":"Care flow ID","description":"The care flow to get the data point value from. Can be a different care flow than the current one.","type":"string","required":true},"dataPointDefinitionId":{"id":"dataPointDefinitionId","label":"Data point definition ID","description":"The data point definition ID to get the value from.","type":"string","required":true}},"dataPoints":{"valueString":{"key":"valueString","valueType":"string"},"valueNumber":{"key":"valueNumber","valueType":"number"},"valueDate":{"key":"valueDate","valueType":"date"},"valueJson":{"key":"valueJson","valueType":"json"},"valueBoolean":{"key":"valueBoolean","valueType":"boolean"},"valueTelephone":{"key":"valueTelephone","valueType":"telephone"},"valueStringsArray":{"key":"valueStringsArray","valueType":"strings_array"},"valueNumbersArray":{"key":"valueStringsArray","valueType":"strings_array"}},"previewable":false},"listFormAnswers":{"key":"listFormAnswers","title":"List form answers","description":"List form answers","category":"Workflow","fields":{"scope":{"id":"scope","label":"Scope","description":"The scope in which to look for forms. Default is \"Step\" (current step only).","type":"string","required":false,"options":{"dropdownOptions":[{"label":"Step","value":"Step"},{"label":"Track","value":"Track"}]}},"formSelection":{"id":"formSelection","label":"Form selection","description":"Whether to capture the most recent form or all forms in the scope. Default is \"Latest\". Form headers will be included if \"All\" is selected.","type":"string","required":false,"options":{"dropdownOptions":[{"label":"Latest","value":"Latest"},{"label":"All","value":"All"}]}},"language":{"id":"language","label":"Language","description":"The language the output should be in. Default is English.","type":"string","required":false,"options":{"dropdownOptions":[{"label":"English","value":"English"},{"label":"Dutch","value":"Dutch"},{"label":"French","value":"French"}]}},"includeDescriptions":{"id":"includeDescriptions","label":"Include descriptions","description":"Should descriptions be included in the output? Default is \"Yes\".","type":"boolean","required":false},"includeMissingAnswers":{"id":"includeMissingAnswers","label":"Include missing answers","description":"Should missing or unanswered questions be included in the output? Default is \"Yes\".","type":"boolean","required":false},"separator":{"id":"separator","label":"Separator","description":"The separator to use between questions. If not provided, questions will be separated by a blank line.","type":"string","required":false}},"dataPoints":{"output":{"key":"output","valueType":"string"},"numberOfFormsCaptured":{"key":"numberOfFormsCaptured","valueType":"number"}},"previewable":false},"createNaviSession":{"key":"createNaviSession","title":"Create Navi Session","description":"Create a Navi portal session for a stakeholder","category":"Workflow","fields":{"stakeholderId":{"id":"stakeholderId","label":"Stakeholder","description":"The stakeholder to create the session for. Leave empty to default to the patient.","type":"string","required":false},"exp":{"id":"exp","label":"Expiration (epoch seconds)","description":"When the session should expire, as a Unix timestamp in seconds. If left empty, we default to 30 days.","type":"string","required":false}},"dataPoints":{"sessionId":{"key":"sessionId","valueType":"string"},"naviSessionUrl":{"key":"naviSessionUrl","valueType":"string"},"statusCode":{"key":"statusCode","valueType":"string"}},"previewable":false},"getCurrentCareflowId":{"key":"getCurrentCareflowId","title":"Get current care flow ID","description":"Get the current care flow ID","category":"Workflow","fields":{},"dataPoints":{"careFlowId":{"key":"careFlowId","valueType":"string"},"careFlowDefinitionId":{"key":"careFlowDefinitionId","valueType":"string"}},"previewable":false}},"webhooks":[{"key":"pathwayCompleted","dataPoints":{"pathway_definition_id":{"key":"pathway_definition_id","valueType":"string"},"complete_date":{"key":"complete_date","valueType":"date"}}},{"key":"pathwayStart","description":"Start a pathway via webhook. No data points are expected nor required.","dataPoints":{}}],"description":"Enrich your care flows with powerful Awell actions.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1678870116/Awell%20Extensions/Awell_Logo.png","title":"Awell Workflow","category":"Workflow","author":{"authorType":"Awell"},"settings":{}},{"key":"awellTasks","htmlDocs":"\n
title: Awell Tasks
\ndescription: Awell Tasks is an extension that allows communication with the Task Service module.
\nAwell Tasks
\nAwell Tasks is an extension that allows communication with the Task Service module.
","changelog":"CHANGELOG
","actions":{"getComments":{"key":"getComments","title":"Get comments","description":"Retrieves all comments in a care flow.","category":"Communication","fields":{},"previewable":false,"dataPoints":{"comments":{"key":"comments","valueType":"string"}},"supports_automated_retries":true},"getLastTaskPerformer":{"key":"getLastTaskPerformer","title":"Get last task performer","description":"Retrieves the performer of the last task.","category":"Communication","fields":{},"previewable":false,"dataPoints":{"stytchUserId":{"key":"stytchUserId","valueType":"string"},"email":{"key":"email","valueType":"string"}},"supports_automated_retries":true}},"webhooks":[],"description":"Connect to Awell Tasks","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1736765692/Awell%20Extensions/AwellTasks.png","title":"Awell Tasks","category":"Workflow","author":{"authorType":"Awell"},"settings":{"baseUrl":{"key":"baseUrl","label":"Base URL","obfuscated":false,"description":"The base URL of the Task ServiceAPI","required":true},"apiKey":{"key":"apiKey","label":"API key","obfuscated":true,"description":"The API key for the Task Service API","required":true}}},{"key":"calDotCom","htmlDocs":"\n
title: Cal.com
\ndescription: Cal.com is a modern and open source scheduling platform. With HIPAA, GDPR and SOC2 compliance, you can ensure that data is well-protected and that makes Cal.com a great fit for healthcare use cases.
\nCal.com
\nCal.com is a modern and open source scheduling platform. With HIPAA, GDPR and SOC2 compliance, you can ensure that data is well-protected and that makes Cal.com a great fit for healthcare use cases.
\nCal.com x Awell
\nThis extension allows you to let a stakeholder (eg: a patient) book an appointment as part of a care flow and to retrieve the booking details of an appointment.
\nExtension settings
\nIn order to set up this extension, you will need to provide a Cal.com API key. You can obtain an API key via the Cal.com portal (Settings > Developer > API keys).
Custom Actions
\nBook appointment action
\nYou can add this action to your care flow to enable a stakeholder (eg: a patient) to book an appointment in a predefined calendar. This is a stakeholder-actionable action which means it requires an actual user to book an appointment. Also note that this is a blocking action and that the care flow will not progress - unless there are parallel tracks or transitions - until the action/activity is completed (i.e. an appointment was booked).
\nThe actual booking of the appointment can happen in two ways:
\n- \n
- With Awell Hosted Pages: when the \"Book appointment\" action is activated, we serve the booking widget to the stakeholder so they can book an appointment directly from within Awell Hosted Pages. \n
- If you are not leveraging Awell Hosted Pages but have built a custom integration then we expose you all the details via our API so you can either create a Cal.com booking widget yourself or redirect the user to the Cal.com platform. Additionally, we expose a mutation that allows you to complete the activity and pass in the required data. \n
Below you can find an overview of all Awell Apps and whether they support rendering of the booking widget.
\n| App | \nSupported | \n
|---|---|
| Awell Hosted Pages | \nYes | \n
| Your app (custom integration) | \nYes | \n
| Awell Care | \nNo | \n
| Awell MyCare | \nNo | \n
Data points
\nAdding this action to your care flow will expose a new data point you can use in your care flow, the bookingId. When the care flow is orchestrated and the book appointment activity is completed, the id of the actual booking will be ingested as the value of that bookingId data point.
Get booking action
\nThis action allows you to fetch the details of a booking based on the provided bookingId. This action will make the following data points available for you to use in your care flow:
- \n
- Event type ID \n
- Title \n
- Description \n
- Start time \n
- End time \n
- Status \n
- Cancel URL \n
- Reschedule URL \n
- Video call URL (if available) \n
- First Attendee's name \n
- First Attendee's timezone \n
- First Attendee's email \n
- Organizer's email \n
Update booking
\nUpdates a booking and saves new bookingId and bookingUid as Data Points. Values possible to update:
- \n
- Title - Title of Booking event \n
- Description - Description of the meeting \n
- Status - Status of the meeting to be set. Possible values: \"ACCEPTED\", \"PENDING\", \"CANCELLED\", \"REJECTED\". \n
- Start - Start time of the Event in ISO 8601 format, e.g. 2023-05-24T13:00:00.000Z. Please note that start/end time must be within user's availability hours. \n
- End - End time of the Event in ISO 8601 format, e.g. 2023-05-24T13:00:00.000Z. Please note that start/end time must be within user's availability hours. \n
Create booking
\nCreates a booking and saves new bookingId as Data Points. Available fields:
- \n
- Event Type ID - ID of the event type to book \n
- Responses - Object containing email, name, location \n
json\n \"responses\": {\n \"name\": \"John Doe\",\n \"email\": \"john.doe@example.com\",\n \"location\": \"Calcom HQ\"\n },\n\n- Metadata - Any metadata associated with the booking \n
- Timezone - Timezone of the Attendee \n
- Language - Language of the Attendee \n
- Recurring Event ID - Recurring Event ID if the event is recurring \n
- Title - Title of Booking event \n
- Description - Description of the meeting \n
- Status - Status of the meeting to be set. Possible values: \"ACCEPTED\", \"PENDING\", \"CANCELLED\", \"REJECTED\". \n
- Start - Start time of the Event in ISO 8601 format, e.g. 2023-05-24T13:00:00.000Z. Please note that start/end time must be within user's availability hours. \n
- End - End time of the Event in ISO 8601 format, e.g. 2023-05-24T13:00:00.000Z. Please note that start/end time must be within user's availability hours. \n
Delete Boooking
\nDeletes a Booking with a given ID.
\nPricing
\nThis extension is free but keep in mind that you might need a paid plan for Cal.com depending on your needs.
\nLimitations
\nRescheduling
\nWhen a previously made booking is rescheduled, there is no way yet to get the new/updated booking details into the care flow or have the care flow react on the updated booking.
\nAlso note that when a booking is rescheduled, Cal.com doesn't update the original booking resource but creates a new one instead. As far as we know, there is no reference from the old booking to the new (rescheduled) booking.
\nExample
\nAn appointment has been booked with Cal.com and we have the below booking resource:
\n{\n ...,\n \"bookingId\": \"1\",\n \"date\": \"Jan 1, 2023\"\n}\nHowever, the patient reschedules the booking to Jan 10, 2023. When querying Cal.com's API (GET v1/bookings/{bookingId}), it will still return the old booking date instead of the new/rescheduled date.
{\n ...,\n \"bookingId\": \"1\",\n \"date\": \"Jan 1, 2023\"\n}\nWebhooks
\nWebhooks offer a great way to automate the flow with Awell when invitees schedule, cancel, or reschedule events, or when the meeting ends.
\nImportant notes:
\n- \n
- An Awell webhook endpoint can only listen to one event type. So make sure that when you create a webhook in Cal.com, the subscriber URL and the event trigger match the Awell webhook endpoint. This also means there can only be one event type per subscriber URL. \n
- Using a secret to verify the authenticity of the received payload is not yet supported. \n
- Custom payload templates are not supported, please use the default ones. \n
Cal.com changelog
\nSeptember 15, 2023
\n- \n
- add createBooking action \n
- add first attendee name and timezone to getBooking data points \n
September 4, 2023
\n- \n
- add updateBooking and deleteBooking actions \n
- update and refactor structure of getBooking and bookAppointment actions \n
July 4, 2023
\n- \n
- Get booking action: add validation that bookingId and apiKey are not empty \n
- Get booking action: add validation of response data to make sure we have data points \n
April 27, 2023
\n- \n
- Get booking action:
startTimeandendTimedata points are now of value typedateinstead ofstring. \n
\n
title: Calendly
\ndescription: Calendly is your scheduling automation platform for eliminating the back-and-forth emails to find the perfect time
\nCalendly
\nCalendly is the scheduling automation platform with team-based scheduling, solutions and integrations for every department, and advanced security features. Note that Calendly is not HIPAA-compliant, so is not endorsed by Awell. If you wish to use a HIPAA-compliant scheduling solution, we recommend using our Cal.com extension instead.
\nExtension settings
\nIn order to set up this extension, you will need to provide a Calendly API key. You can obtain an API key via the Calendly portal (Settings > Developer > API keys).
Pricing
\nThis extension is free but keep in mind that you might need a paid plan for Calendly depending on your needs.
\nWebhooks
\nWebhooks offer a great way to automate the flow with Awell when invitees schedule, cancel, or reschedule events, or when the meeting ends.
\nImportant notes:
\n- \n
- An Awell webhook endpoint can only listen to one event type. So make sure that when you create a webhook in Calendly, the subscriber URL and the event trigger match the Awell webhook endpoint. This also means there can only be one event type per subscriber URL. \n
- Using a secret to verify the authenticity of the received payload is not yet supported. \n
- Custom payload templates are not supported, please use the default ones. \n
Notes about rescheduled appointments
\nApparently, Calendly doesn't make it completely clear when an invitee.created event is created and sent via a webhook. Instead, the rescheduled field is part of the invitee.cancelled webhook, and the old_invitee field is populated in the new invitee.created event. So, this extension uses a is_rescheduled_event field in the invitee.created listener to reflect an old_invitee being present. So:
In order to check to see if an event was rescheduled (rather than a new event):
\n- \n
- validate
is_rescheduled_eventis true \n
In order to understand if a cancellation was actually a rescheduling:
\n- \n
- validate
rescheduledis true \n
Calendly changelog
\nNovember 3, 2023
\n- \n
- Calendly webhooks for event created, canceled and rescheduled are now supported. \n
November 20, 2023
\n- \n
- Removed rescheduled event; expectation is that the rescheduling should be handled on the client side, given Calendly does not direcly support a rescheduled webhook \n
\n
title: Canvas Medical
\ndescription: Canvas Medical is a healthcare platform that empowers care delivery companies to revolutionize digital health experiences for their patients and users.
\nCanvas Medical
\nCanvas Medical is a healthcare platform that empowers care delivery companies to revolutionize digital health experiences for their patients and users. Leveraging certified EHR as a foundation, Canvas Medical offers a comprehensive suite of APIs, enabling customers to swiftly launch innovative patient experiences and cost-effective business models.
\nCanvas Medical provides appointment management, patient data creation and updates, task management, questionnaire creation, and much more.
\nExtension settings
\nFor the extension to function correctly, you must include the following elements in your settings:
\nclient_id and client_secret: These values are generated on the Canvas Medical platform.\nbase_url: This determines the base URL for your FHIR endpoint.\nauth_url: This determines the base URL for your authorization endpoint.
Create appointment
\nEasily schedule appointments with providers using the Canvas API. This action allows you to reserve a meeting with a healthcare provider by submitting appointmentData in JSON format. Upon successful execution, the data points returns the unique appointmentId, serving as the key within the Canvas API object.
Create patient
\nEffortlessly create patients using the Canvas API. This action allows you to generate a new patient record by submitting patientData in JSON format. Upon successful execution, the data points returns the unique patientId, serving as the key within the Canvas API object.
Create task
\nEfficiently create tasks associated with a specific patient using the Canvas API. This action allows you to generate a new task linked to a designated patient by submitting taskData in JSON format. Upon successful execution, the data points returns the unique taskId, serving as the key within the Canvas API object.
Create questionnaire responses
\nCreate questionnaire responses using the Canvas API to effortlessly record answers within an existing questionnaire. This action requires several parameters:
\n- \n
Questionnaire ID: Reference to the Canvas Questionnaire using the questionnaire id. \nSubject ID: Reference to the Canvas Patient using the patient id. \nAuthored: Timestamp when the Questionnaire response was filled out (If omitted, the current timestamp at data ingestion will be used). \nAuthor ID: Reference to the patient or practitioner filling out the questionnaire. If omitted, it defaults to Canvas Bot. \nItem: List of answers to questions in the questionnaire. \n
Upon successful execution, the data points returns questionnaireResponseId, which serves as the key within the Canvas API object.
Update appointment
\nEffortlessly cancel or modify a reserved appointment using the Canvas API. This action allows you to update appointment details by submitting appointmentData in JSON format. Upon successful execution, the data points returns the appointmentId, serving as the key within the Canvas API object.
Update patient
\nEfficiently update existing patient information within the system using the Canvas API. This action allows you to modify data by submitting patientData in JSON format. Upon successful execution, the data points returns the patientId, which serves as the key within the Canvas API object
Update task
\nEfficiently update existing task information within the system using the Canvas API. This action allows you to modify data by submitting taskData in JSON format. Upon successful execution, the action returns the taskId, which serves as the key within the Canvas API object.
Create coverage
\nEfficiently create a coverage using the Canvas API. This action requires several parameters:
\n- \n
Order: Specifies the order in which insurance coverages should be utilized when processing claims. \nStatus: Refers to the statuses represented within the Canvas Medical system. \nType: Pertains to the Insurance Coverage Code Category, such as medical or accident, using values from http://hl7.org/fhir/ValueSet/coverage-type. \nSubscriber: Refers to the Canvas Patient using the patient ID, serving as the resource for the coverage's subscriber. \nSubscriber ID: Refers to the Canvas Patient using the patient ID. \nBeneficiary: Specifies the intended patient for the coverage. \nRelationship: Relates to the beneficiary's relationship to the subscriber, as defined in the http://hl7.org/fhir/ValueSet/. \nPeriod start: Indicates when the coverage became active for the patient. \nPeriod end: Indicates when the coverage ceased to be active for the patient. \nPayor: Relates to the entity responsible for payment. \nClass: Utilized to define the plan, subplan, group, and subgroup. \n
Update coverage
\nEfficiently update existin coverage using the Canvas API. This action requires several parameters:
\n- \n
Id: Reference to the Canvas Coverage using the coverage id. \nOrder: Specifies the order in which insurance coverages should be utilized when processing claims. \nStatus: Refers to the statuses represented within the Canvas Medical system. \nType: Pertains to the Insurance Coverage Code Category, such as medical or accident, using values from http://hl7.org/fhir/ValueSet/coverage-type. \nSubscriber: Refers to the Canvas Patient using the patient ID, serving as the resource for the coverage's subscriber. \nSubscriber ID: Refers to the Canvas Patient using the patient ID. \nBeneficiary: Specifies the intended patient for the coverage. \nRelationship: Relates to the beneficiary's relationship to the subscriber, as defined in the http://hl7.org/fhir/ValueSet/. \nPeriod start: Indicates when the coverage became active for the patient. \nPeriod end: Indicates when the coverage ceased to be active for the patient. \nPayor: Relates to the entity responsible for payment. \nClass: Utilized to define the plan, subplan, group, and subgroup. \n
Create claim
\nCreate claim using the Canvas API. This action requires several parameters:
\n- \n
status: Status compliant with Canvas Medical. \ntype: Type compliant with Canvas Medical. \npatientId: Reference to the Canvas Patient using the patient id. \ncreated: The field indicating when this claim resource was created \nprovider: The field related to determining personnel resources for services in the statement \nsupportingInfo: Supporting info compliant with Canvas Medical. \ndiagnosis: The field represents the list will create the Assessments in Canvas for this claim. \ninsurance: The field represents the list of elements that defines what coverages are to be used when adjudicating the claim. \nitem: The field represents the list of service charges to be used in the claim. \n
Upon successful execution, the data points returns claimId, which serves as the key within the Canvas API object.
Canvas Medical changelog
\n2023-09-01
\n- \n
- Add new actions:
createAppointment,createPatient,createQuestionnaireResponses,createTask,updateAppointment,updatePatient, andupdateTaskfor enhanced functionality. \n
\n
title: Cerner
\ndescription: Cerner EMR is an electronic medical records system that helps healthcare organizations improve patient care and increase efficiency.
\nCerner
\nCerner EMR is an electronic medical records system that helps healthcare organizations improve patient care and increase efficiency.
\nThe Cerner extension
\nThe Cerner Extension is designed to support Read and Write integrations via SMART Backend Services. These integrations are server-to-server (backend) and do not require direct user interaction—whether from patients or practitioners. The extension connects to Cerner's FHIR R4 API.
\nIn addition to REST interfaces, customers using Cerner usually also have healthcare-specific interfaces, like HL7, enabling tasks such as querying patient demographics (ADR A19) or creating documents (ORU messages). Awell supports these interfaces as well.
\nSetup
\nTo set up the Cerner Extension in Awell, you’ll need to configure the following:
\n- \n
- Tenant ID: the tenant ID associated to the organization you are connecting to (more info) \n
- Client ID: the client ID of the Cerner app used to authenticate. (more info) \n
- Client secret: the client secret of the Cerner app used to authenticate (more info) \n
Important: The actions below list what scopes are required to be added to the Cerner app. Without the scopes, the actions will not work as the app will not have the necessary permissions to access the data.
\nActions
\nGet patient (R4)
\nRetrieve a patient’s details using their FHIR resource ID. This action returns the full FHIR Patient resource.
\nRequired application scopes: system/Patient.read
Create patient (R4)
\nAdd a new patient to Cerner using demographic information. Required fields include:
\n- \n
- Assigning Organization ID \n
- Given name \n
- Family name \n
While optional, including additional demographic information such as email address, data of birth, etc is highly recommended to improve accuracy when matching patients in the future.
\nThe action will return the FHIR resource ID of the created patient.
\nRequired application scopes: system/Patient.write
Find patient by MRN (R4)
\nLeverages the Patient.search (R4) operation to find a patient by their MRN. The action will return the FHIR resource ID of the patient.
Note: the default identifier system used to look up the patient based on MRN is urn:oid:2.16.840.1.113883.6.1000.
Required application scopes: system/Patient.read
Get appointment (R4)
\nRetrieve details of a specific appointment using its FHIR resource ID. The action returns the full FHIR Appointment resource.
\nRequired application scopes: system/Appointment.read
Get patient encounters (R4)
\nRetrieve all encounters for a patient using their FHIR resource ID. The action returns all FHIR Encounter resources for the patient.
\nRequired application scopes: system/Encounter.read
Create document (R4)
\nCreate a new document reference (clinical note) in Cerner. The action returns the FHIR resource ID of the created document reference.
\nRequired application scopes: system/DocumentReference.write
Get encounter (R4)
\nRetrieve details of a specific encounter using its FHIR resource ID. The action returns the full FHIR Encounter resource.
\nRequired application scopes: system/Encounter.read
Cerner changelog
","actions":{"getPatient":{"key":"getPatient","title":"Get patient","description":"Retrieve patient details from Cerner","category":"EHR Integrations","fields":{"resourceId":{"id":"resourceId","label":"Patient resource ID","description":"The resource ID of the patient","type":"string","required":true}},"previewable":true,"dataPoints":{"patient":{"key":"patient","valueType":"json"}}},"createPatient":{"key":"createPatient","title":"Create patient","description":"Create a patient in Cerner","category":"EHR Integrations","fields":{"assigningOrganizationId":{"id":"assigningOrganizationId","label":"Assigning organization ID","type":"string","description":"The ID of the organization that is creating the patient.","required":true},"ssn":{"id":"ssn","label":"SSN","type":"string","description":"The patient’s Social Security Number.","required":false},"familyName":{"id":"familyName","label":"Family name","type":"string","description":"The patient’s family (last) name.","required":true},"givenName":{"id":"givenName","label":"Given name","type":"string","description":"The patient's given name. May include first and middle names.","required":true},"birthDate":{"id":"birthDate","label":"Birth date","type":"date","required":false},"gender":{"id":"gender","label":"Gender","type":"string","required":false,"options":{"dropdownOptions":[{"value":"male","label":"Male"},{"value":"female","label":"Female"},{"value":"other","label":"Other"},{"value":"unknown","label":"Unknown"}]}},"email":{"id":"email","label":"Email","type":"string","required":false}},"previewable":true,"dataPoints":{"resourceId":{"key":"resourceId","valueType":"string"}}},"findPatientByMRN":{"key":"findPatientByMRN","title":"Find patient by MRN","description":"Find patient by MRN in Cerner","category":"EHR Integrations","fields":{"MRN":{"id":"MRN","label":"Medical Record Number (MRN)","type":"string","description":"","required":true}},"previewable":true,"dataPoints":{"resourceId":{"key":"resourceId","valueType":"string"}}},"getAppointment":{"key":"getAppointment","title":"Get appointment","description":"Retrieve appointment details from Cerner","category":"EHR Integrations","fields":{"resourceId":{"id":"resourceId","label":"Appointment resource ID","description":"The resource ID of the appointment.","type":"string","required":true}},"previewable":true,"dataPoints":{"appointment":{"key":"appointment","valueType":"json"},"patientId":{"key":"patientId","valueType":"string"},"appointmentStatus":{"key":"appointmentStatus","valueType":"string"},"appointmentStartDateTime":{"key":"appointmentStartDateTime","valueType":"date"},"appointmentTypeCode":{"key":"appointmentTypeCode","valueType":"string"}}},"createDocument":{"key":"createDocument","title":"Create document","description":"Create a document in Cerner","category":"EHR Integrations","fields":{"patientResourceId":{"id":"patientResourceId","label":"Patient resource ID","type":"string","description":"The patient’s FHIR resource ID.","required":true},"encounterResourceId":{"id":"encounterResourceId","label":"Encounter resource ID","description":"The FHIR resource ID of the related encounter.","type":"string","required":true},"type":{"id":"type","label":"Document type","type":"string","required":true,"options":{"dropdownOptions":[{"value":"Progress Note","label":"Progress Note"}]}},"note":{"id":"note","label":"Note","type":"text","required":true}},"previewable":true,"dataPoints":{"resourceId":{"key":"resourceId","valueType":"string"}}},"getPatientEncounters":{"key":"getPatientEncounters","title":"Get patient encounters","description":"Retrieve all encounters for a patient","category":"EHR Integrations","fields":{"patientResourceId":{"id":"patientResourceId","label":"Patient resource ID","description":"The resource ID of the patient","type":"string","required":true}},"previewable":true,"dataPoints":{"encounters":{"key":"encounters","valueType":"json"}}},"getEncounter":{"key":"getEncounter","title":"Get encounter","description":"Retrieve encounter details from Cerner","category":"EHR Integrations","fields":{"resourceId":{"id":"resourceId","label":"Encounter resource ID","description":"The resource ID of the encounter","type":"string","required":true}},"previewable":true,"dataPoints":{"encounter":{"key":"encounter","valueType":"json"}}}},"webhooks":[],"description":"Cerner EMR is an electronic medical records system that helps healthcare organizations improve patient care and increase efficiency.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1736327719/Awell%20Extensions/CERN-4c75d8aa.png","title":"Cerner","category":"EHR Integrations","author":{"authorType":"Awell"},"settings":{"tenantId":{"key":"tenantId","label":"Tenant ID","required":true,"obfuscated":false,"description":"The tenant ID associated to the organization you are connecting to."},"clientId":{"key":"clientId","label":"Client ID","required":true,"obfuscated":false,"description":"The client ID of the Cerner app used to authenticate."},"clientSecret":{"key":"clientSecret","label":"Client Secret","required":true,"obfuscated":true,"description":"The client secret of the Cerner app used to authenticate."}}},{"key":"cloudinary","htmlDocs":"\n
title: Cloudinary
\ndescription: Cloudinary is a cloud-based image and video management platform that provides a comprehensive set of tools for storing, managing, and delivering digital media assets.
\nCloudinary
\nCloudinary is a cloud-based image and video management platform that provides a comprehensive set of tools for storing, managing, and delivering digital media assets. It enables users to upload, manipulate, optimize, and deliver media files to any device or website quickly and easily.
\nThe platform offers features such as image and video transformation, automatic image optimization, and responsive image delivery. Cloudinary also provides tools for organizing media assets, including tags, folders, and metadata.
\nSet up
\nTo set up this extension and allow image upload you will need to:
\n- \n
- Have a Cloudinary account and know your cloud name \n
- Created an upload preset that allows for unsigned uploads \n
Custom Actions
\nUpload single file
\nAllows a user to upload a single file using Awell Hosted Pages (all file types allowed). The URL of the uploaded file is returned as a data point.
\nUpload files
\nThis action allows a given stakeholder to upload one or many files using Awell Hosted Pages (all file types allowed). This action currently doesn't return the URLs of the uploaded files. If you need this functionality, please use the \"Upload single file\" action for now.
","changelog":"Cloudinary changelog
\nOctober 2023
\n- \n
- Action added: Upload a single file \n
\n
title: cm.com
\ndescription: CM.com is a global communication and digital services provider based in the Netherlands.
\nCM.com
\nCM.com is a global communication and digital services provider based in the Netherlands. It offers a wide range of services and solutions in the areas of messaging, payments, voice, and customer experience.
\nCM.com enables businesses to communicate with their customers through various channels such as SMS, email, push notifications, social media messaging, and more.
\nExtension settings
\nIn order to set up this extension, you will need:
\n- \n
- A Product Token - visit https://gateway.cmtelecom.com/ to retrieve your product token. \n
- A From/sender name - the maximum length is 11 alphanumerical characters or 16 digit \n
Custom Actions
\nSend SMS
\nSend an SMS with CM.com to a recipient of your liking.
","changelog":"CM.com changelog
","actions":{"sendSms":{"key":"sendSms","title":"Send SMS","description":"Send a text message to a recipient of your choice.","category":"Communication","fields":{"fromName":{"label":"From name","id":"fromName","type":"string","required":false,"description":"This is the sender's name. The maximum length is 11 alphanumerical characters or 16 digits. When left blank, the \"From name\" from the extension settings will be used."},"recipient":{"id":"recipient","label":"\"To\" phone number","type":"string","stringType":"phone","description":"The phone number you would like to send the text message to.","required":true},"message":{"id":"message","label":"Message","description":"The message you would like to send.","type":"text","required":true}},"previewable":true}},"webhooks":[],"description":"cm.com is a communications Platform for Messaging & Voice","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1687860653/Awell%20Extensions/cm-f4ffa018.png","title":"cm.com","category":"Communication","author":{"authorType":"Awell"},"settings":{"productToken":{"label":"Product Token","key":"productToken","obfuscated":true,"required":true,"description":"This is the product token for authentication. Visit https://gateway.cmtelecom.com/ to retrieve your product token."},"fromName":{"label":"From/sender name","key":"fromName","obfuscated":false,"required":false,"description":"This is the sender's name. The maximum length is 11 alphanumerical characters or 16 digits"}}},{"key":"collectData","htmlDocs":"\n
title: Advanced data collection
\ndescription: Collect data from your users using a variety of input types and data sources
\nThis extension allows you to collect data from your users using a variety of more advanced input types and data sources.
\nExtension settings
\nIn order to set up this extension, no settings are required.
\nCustom Actions
\nDynamic choice selector
\nStandard select questions in Awell forms have a discrete set of choices to select from that are defined at the time that the form is created. If the list of choices to present to your responders isn't known at the time the form is being built, or changes often, this action allows you to load choices dynamically from a remote data source.
\nDynamically-loaded choices must minimally adhere to the following format in a list form (i.e. an array):
\n[\n {\n \"id\": \"unique-id-1\",\n \"label\": \"Choice label 1\",\n \"value\": \"Choice value 1\"\n },\n {\n \"id\": \"unique-id-2\",\n \"label\": \"Choice label 2\",\n \"value\": \"Choice value 2\"\n }\n]\nThe id, label, and value fields are required. However, additional fields can be added to the object. Besides the label and value, which are available as distinct data points, the additional data of the selected choice will also be returned as a data point.
Example:
\n[\n {\n \"id\": \"unique-id-1\",\n \"label\": \"Choice label 1\",\n \"value\": \"Choice value 1\",\n \"additionalData\": \"Additional data\",\n \"nestedData\": {\n \"nested\": \"value\"\n }\n }\n]\nAdditionally, you can specify a free text search field (Options - Search query param field) to allow users to search through the choices. This is optional but highly recommended. If not specified, the choices will be fetched on question load and presented in a static list that cannot be filtered.
As an example, using the endpoint https://example.com/choices with a query parameter search (e.g. https://example.com/choices?search=QUERY where QUERY is whatever the user typed into the input), then the API is expected to return the choices based on that match the search term.
We recommend that your search logic returns an _alphabetically-sorted_ list of all options where the _lowercase_ label names _contain_ the _lowercase_ search term.
\n// Example search logic\nconst searchTerm = req.query.search\nconst results = []\n\noptions.forEach((option) => {\n if (option.label.toLowerCase().includes(searchTerm.toLowerCase())) {\n results.push({\n label: option.label,\n value: option.value,\n id: option.id,\n })\n }\n})\n\nconst sortedResults = results.sort((a, b) => a.label.localeCompare(b.label))\nres.json(results)\nCollect medication
\nThis action enables patients to list their medications. They can add multiple medications, providing the name, dosage, and any specific instructions for each one.
","changelog":"Collect Data changelog
","actions":{"collectMedication":{"key":"collectMedication","title":"Collect medication","description":"Collect medication from the user","category":"Forms","fields":{"label":{"id":"label","label":"Label","type":"string","required":false,"description":"A label or description that will be shown above the question"}},"dataPoints":{"medicationData":{"key":"medicationData","valueType":"json"},"medicationDataString":{"key":"medicationDataString","valueType":"string"},"prettyMedicationData":{"key":"prettyMedicationData","valueType":"string"}},"options":{"stakeholders":{"label":"Stakeholder","mode":"single"}},"previewable":false},"remoteSingleSelect":{"key":"remoteSingleSelect","title":"Dynamic choice selector","description":"The dynamic choice selector allow you to set up a select question where the available choices are dynamically populated through an API lookup","category":"Forms","fields":{"label":{"id":"label","label":"Select - Label","description":"Enter the label text that will be displayed before the selector.","type":"string","required":true},"mandatory":{"id":"mandatory","label":"Select - Response required?","description":"The user must select an option before continuing.","type":"boolean","required":true},"url":{"id":"url","label":"Options - Endpoint URL","description":"Enter the URL (starting with `https://`) where the options to display can be fetched. The endpoint must return an array of objects with the following properties: `id`, `label` and `value`.","type":"string","required":true},"headers":{"id":"headers","label":"Options - Headers","description":"Enter the headers to send to the options source URL. The headers must be in JSON format.","type":"json","required":false},"queryParam":{"id":"queryParam","label":"Options - Search query param","description":"Enter the key of the free text search query param if the endpoint supports this e.g. `search` for `https://example.com/options?search=foo`.","type":"string","required":false}},"dataPoints":{"value":{"key":"value","valueType":"string"},"label":{"key":"label","valueType":"string"},"selectedOption":{"key":"selectedOption","valueType":"json"}},"options":{"stakeholders":{"label":"Stakeholder","mode":"single"}},"previewable":false},"arrayTest":{"key":"arrayTest","title":"Array fields test","description":"Just to show string and numeric array fields","category":"Demo","fields":{"stringArray":{"id":"stringArray","label":"String Array","description":"Select a data point or enter comma separated strings.","type":"string_array","required":true,"options":{"dropdownOptions":[{"value":"one","label":"One"},{"value":"two","label":"Two"},{"value":"three","label":"Three"}]}},"numericArray":{"id":"numericArray","label":"Numeric Array","description":"Select a data point or enter comma separated numbers.","type":"numeric_array","required":true,"options":{"dropdownOptions":[{"label":"One","value":1},{"label":"Two","value":2},{"label":"Three","value":3}]}},"anotherStringArray":{"id":"anotherStringArray","label":"String Array","description":"Select a data point or enter comma separated strings.","type":"string_array","required":true,"options":{"dropdownOptions":[{"label":"Option 1","value":"option1"},{"label":"Option 2","value":"option2"}]}},"anotherNumericArray":{"id":"anotherNumericArray","label":"Numeric Array","description":"Select a data point or enter comma separated numbers.","type":"numeric_array","required":true,"options":{"dropdownOptions":[{"label":"Option 1","value":50},{"label":"Option 2","value":51}]}}},"dataPoints":{"allStrings":{"key":"allStrings","valueType":"strings_array"},"allNumbers":{"key":"allNumbers","valueType":"numbers_array"}},"previewable":true}},"webhooks":[],"description":"This extension allows you to collect data from your users using a variety of advanced input types and data sources.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1678870116/Awell%20Extensions/Awell_Logo.png","title":"Advanced data collection","category":"Forms","author":{"authorType":"Awell"},"settings":{}},{"key":"customerIo","htmlDocs":"\n
title: Customer.io
\ndescription: Customer.io is a customer engagement platform designed to create personalized customer journeys that engage, convert, and scale.
\nCustomer.io
\nCustomer.io is a customer engagement platform designed to create personalized customer journeys that engage, convert, and scale.
\nSettings and setup
\nTo start using the Customer.io extension, you need to create an account and get your API key and site ID.
\nActions
\nTrack person event
\nTracks an event for a person in Customer.io. You can identify a person using email, cio_id or id, give your event a name and optional attributes.
By default, Awell adds the following attributes to the event:
\n- \n
_awell_careflow_id: The ID of the careflow. \n_awell_careflow_definition_id: The ID of the careflow definition. \n_awell_patient_id: The ID of the patient. \n_awell_activity_id: The ID of the activity. \n_awell_identifier_{system_namespace}: For every identifier the patient has in Awell, an attribute is added with the system namespace as the key and the identifier value as the value. \n
Customer.io changelog
","actions":{"trackPersonEvent":{"key":"trackPersonEvent","title":"Track person event","description":"Track a person event in Customer.io","category":"Customer Support","fields":{"personIdentifierType":{"id":"personIdentifierType","label":"Person identifier type","description":"The identifier type used to identify the person. Defaults to email.","type":"string","required":true,"options":{"dropdownOptions":[{"label":"id","value":"id"},{"label":"email","value":"email"},{"label":"cio_id","value":"cio_id"}]}},"identifierValue":{"id":"identifierValue","label":"Identifier value","description":"The value of the identifier used to identify the person.","type":"string","required":true},"eventName":{"id":"eventName","label":"Event name","description":"The name of the event. This is how you'll find your event in Customer.io or select it when using events as campaign triggers.","type":"string","required":true},"attributes":{"id":"attributes","label":"Attributes","description":"Additional information that you might want to reference in a message using liquid or use to set attributes on the identified person.","type":"json","required":false}},"previewable":false,"dataPoints":{}}},"webhooks":[],"description":"Customer.io is a customer engagement platform designed to create personalized customer journeys that engage, convert, and scale.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1746447967/Awell%20Extensions/favicon.svg","title":"Customer.io","category":"Customer Support","author":{"authorType":"Awell"},"settings":{"siteId":{"key":"siteId","label":"Site ID","description":"This ID references the workspace you are working in.","obfuscated":false,"required":true},"apiKey":{"key":"apiKey","label":"API Key","description":"The API key needed to authenticate requests to the Customer.io API.","obfuscated":true,"required":true}}},{"key":"dateHelpers","htmlDocs":"\n
title: Date helpers
\ndescription: A set of utility actions to help with common and useful date and time operations.
\nDate helpers
\nA set of utility actions to help with common and useful date and time operations.
\nActions
\nGet next workday
\nReturns the next workday (Monday to Friday) based on a reference date.
\nIf the reference date is a weekday and \"Include reference date\" is enabled, the reference date is returned. If it's a weekend or \"Include reference date\" is disabled, the next weekday is returned instead.
\nExamples:
\n- \n
- Reference date: Thursday, April 17
- \n
- Include reference date enabled → returns Thursday, April 17 \n
- Include reference date disabled → returns Friday, April 18
\n - Reference date: Sunday, April 20
- \n
- Include reference date enabled → returns Monday, April 21 \n
- Include reference date disabled → returns Monday, April 21
\n
✅ Include reference date enabled or disabled → returns Monday, April 21
\nThis action does not account for holidays.
","changelog":"Date helopers
","actions":{"getNextWorkday":{"key":"getNextWorkday","title":"Get Next Workday","description":"Get the next US Federal workday (Defaults to America/Chicago time zone)","category":"Workflow","fields":{"referenceDate":{"id":"referenceDate","label":"Reference date","description":"Set the reference date to calculate the next workday from. If not specified, the current date (today) will be used.","type":"date","required":false},"includeReferenceDate":{"id":"includeReferenceDate","label":"Include reference date","description":"If this option is enabled and the reference date is a work day, that date will be returned. If it is disabled, the next work day after the reference date will be returned.","type":"boolean","required":false},"timezone":{"id":"timezone","label":"Timezone","description":"The IANA timezone identifier to use for the next workday calculation (e.g., \"America/New_York\", \"Europe/London\", \"America/Chicago\", \"UTC\"). If not specified, America/Chicago will be used.","type":"string","required":false}},"dataPoints":{"nextWorkday":{"key":"nextWorkday","valueType":"date"},"referenceDateIsWeekday":{"key":"referenceDateIsWeekday","valueType":"boolean"}},"previewable":true},"checkWorkingHours":{"key":"checkWorkingHours","title":"Check Working Hours","description":"Check if the current time is within working hours and calculate minutes to next working hours as well as the datetime of the next working hours if not","category":"Workflow","fields":{"workingHoursStart":{"id":"workingHoursStart","label":"Working hours start","description":"The start time of working hours in HH:MM format (e.g., \"09:00\"). Uses 24-hour format.","type":"string","required":true},"workingHoursEnd":{"id":"workingHoursEnd","label":"Working hours end","description":"The end time of working hours in HH:MM format (e.g., \"17:00\"). Uses 24-hour format.","type":"string","required":true},"timezone":{"id":"timezone","label":"Timezone","description":"The IANA timezone identifier to use for the working hours check (e.g., \"America/New_York\", \"Europe/London\", \"Asia/Tokyo\", \"UTC\"). If not specified, UTC will be used.","type":"string","required":false}},"dataPoints":{"isWithinWorkingHours":{"key":"isWithinWorkingHours","valueType":"boolean"},"minutesToNextWorkingHours":{"key":"minutesToNextWorkingHours","valueType":"number"},"nextWorkingHoursDatetime":{"key":"nextWorkingHoursDatetime","valueType":"date"}},"previewable":true},"getNextDateOccurrence":{"key":"getNextDateOccurrence","title":"Get next date occurrence","description":"Get the next occurrence of a given date.","category":"Workflow","fields":{"referenceDate":{"id":"referenceDate","label":"Reference date","description":"The date for which to calculate the next occurrence. If the year in the provided date is in the past, the next occurrence is computed in the upcoming year. If omitted, today’s date is used.","type":"date","required":false}},"dataPoints":{"nextDateOccurrence":{"key":"nextDateOccurrence","valueType":"date"}},"previewable":true}},"webhooks":[],"description":"A set of utility actions to help with common and useful date and time operations.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1744914452/Awell%20Extensions/date_helpers.png","title":"Date Helpers","category":"Workflow","author":{"authorType":"Awell"},"settings":{}},{"key":"dockHealth","htmlDocs":"\n
title: Dock Health
\ndescription: HIPAA-compliant task management and workflow automation for healthcare. Assign, track, automate, and complete administrative to-do lists.
\nDock Health
\nHIPAA-compliant task management and workflow automation for healthcare. Assign, track, automate, and complete administrative to-do lists.
\nExtension settings
\nFor the extension to function correctly, you must configure the following settings. You can read more about these settings here.
\n- \n
- Environment (production or development) \n
- Client ID \n
- Client secret \n
- API key \n
- Organiation identifier \n
- User identifier \n
Dock Health changelog
","actions":{"getPatient":{"key":"getPatient","title":"Get patient","description":"Retrieve patient details from Dock","category":"Workflow","fields":{"dockPatientId":{"id":"dockPatientId","label":"Dock patient ID","description":"Identifier of the patient in Dock Health","type":"string","required":true}},"previewable":true,"dataPoints":{"firstName":{"key":"firstName","valueType":"string"},"lastName":{"key":"lastName","valueType":"string"}}},"createTask":{"key":"createTask","title":"Create task","description":"Create a Task in Dock Health","category":"Workflow","fields":{"description":{"id":"description","label":"Description","description":"Description of the task","type":"string","required":true},"taskListId":{"id":"taskListId","label":"Task list ID","description":"The task list identifier.","type":"string","required":true},"patientId":{"id":"patientId","label":"Patient ID","description":"The patient the task is associated with","type":"string","required":false},"taskGroupId":{"id":"taskGroupId","label":"Task group ID","description":"The group to assign the task to","type":"string","required":false}},"previewable":true,"dataPoints":{"taskId":{"key":"taskId","valueType":"string"}}}},"webhooks":[],"description":"HIPAA-compliant task management and workflow automation for healthcare. Assign, track, automate, and complete administrative to-do lists.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1714717332/Awell%20Extensions/images.png","title":"Dock Health","category":"Workflow","author":{"authorType":"Awell"},"settings":{"environment":{"key":"environment","label":"Environment","obfuscated":false,"required":false,"description":"Dock Health supports two environments. Use the \"DEVELOPMENT\" environment to test your code and the \"PRODUCTION\" environment for your live application"},"clientId":{"key":"clientId","label":"Client ID","obfuscated":false,"required":true,"description":"Used to perform the Client Credential grant to obtain an access token"},"clientSecret":{"key":"clientSecret","label":"Client secret","obfuscated":true,"required":true,"description":"Used to perform the Client Credential grant to obtain an access token"},"apiKey":{"key":"apiKey","label":"API key","obfuscated":true,"required":true,"description":"The API key you received from Dock Health."},"organizationId":{"key":"organizationId","label":"Organization ID","obfuscated":false,"required":true,"description":"Identifier of the organization making the request."},"userId":{"key":"userId","label":"User ID","obfuscated":false,"required":true,"description":"Identifier of the user on whose behalf the request is made."}}},{"key":"docuSign","htmlDocs":"\n
title: DocuSign
\ndescription: Make your business faster, simpler and more cost-efficient with electronic agreements. Agree with confidence, with intuitive signing experiences across virtually any device.
\nDocuSign
\nMake your business faster, simpler and more cost-efficient with electronic agreements. Agree with confidence, with intuitive signing experiences across virtually any device.
\nExtension settings
\nIn order to set up this extension, you will need to provide the following settings:
\n- \n
- Integration key (client ID) - An integration key identifies your integration and links to its configuration values. This can be obtained in your developer account from the Apps and Keys page \n
- API Account ID - A GUID value that identifies your account. This can be obtained in your developer account from the Apps and Keys page \n
- Impersonated User ID (UserID) - This is a GUID identifying the DocuSign user that you will be impersonating with the access token. Your own User ID can be found at the top of the Apps and Keys page. \n
- RSA private key (in Base64 format) - This is for the integration key you obtained above and can also be created on the Apps and Keys page (DocuSign also allows uploading your own keys). You only need the private key, and it can only be copied once. Make sure to retain it for your records. Provide it in Base64 format - if you copy the key as is, it will not be valid as newlines and formatting won't be persisted. \n
- Base API URL - Base API URL for API calls matching your environment on DocuSign. Defaults to: https://demo.docusign.net. Can be obtained from Account Base URI section of the Apps and Keys page or the
base_uriproperty in the response of a call to the/oauth/userinfo. \n DEVenvironment: https://demo.docusign.net (default) \nPRODUCTIONenvironment: https://{server}.docusign.net, where{server}is the data center location of your production account (for example, CA, NA2, or EU) \n- Return URL template - Return URL for your application to which DocuSign will redirect the user after signing the document. Set when you self host your application. You can use {sessionId}, {pathwayId}, {activityId} and {stakeholderId} variables to construct the URL, where variables will be replaced with actual values. Defaults to: \"https://goto.development.awell.health/?sessionId={sessionId}\". Remember that this URL MUST match the one you registered for your app in DocuSign settings. See docs for more details. \n
Also, before working with DocuSign you should receive consent of the user to impersonate them with the API calls (even for your own account). Check the details on how to do that on DocuSign docs. It's a ONE TIME operation and is required for API calls to work for specific client-scope-uri combination. Required params explained below:
\n- \n
YOUR_REQUESTED_SCOPES: This extension uses JWT Grant, so in place ofYOUR_REQUESTED_SCOPESyou MUST put at leastsignature%20impersonation. \n- sample consent URL: https://account-d.docusign.com/oauth/auth?response_type=code&scope=signature%20impersonation%20click.manage%20click.send&client_id=XYZ-123&redirect_uri=https://test.com \n
Custom Actions
\nEmbedded signing
\nEmbedded Signing gives users the ability to sign documents directly from Awell Hosted Pages using DocuSign's embedded signing feature. First an embedded signature request with a template is created and then a signing URL is generated for the signature request. Via the signing URL, we can let the user sign the request from within Awell.
\nEmbedded signing behaves as a blocking action where the action is only completed when the signature request is effectively signed.
\nIn order to add embedded signing, you need to add 2 actions to you care flow:
\n- \n
- First, add the \"Create embedded signature request with template\" action. This action will create an embedded signature request based on a template and return a sign URL. \n
- Second, add the \"Embedded signing\" action. In this action you will have to configure the sign URL you got from the first action. \n
Please note that the signing URL generated in the first step is only valid for 5 minutes and is one-time only. This means that from as soon as the first action is activated, the user has 5 minutes to complete the signing request. Loading a session by the user also means that sign url is loaded and refreshing the page will cause the link to expire. When the sign URL has expired, the document cannot be signed anymore and and the process would have to be repeated.
","changelog":"DocuSign changelog
","actions":{"createEmbeddedSignatureRequestWithTemplate":{"key":"createEmbeddedSignatureRequestWithTemplate","title":"Create embedded signature request with template","description":"Let a stakeholder sign a request within Awell based off a template. The care flow will not progress until the request is signed.","category":"Document Management","fields":{"signerRole":{"id":"signerRole","label":"Signer role","description":"Must match an existing role in chosen template. It's case-sensitive.","type":"string","required":true},"signerName":{"id":"signerName","label":"Signer name","description":"The name of the signer.","type":"string","required":true},"signerEmailAddress":{"id":"signerEmailAddress","label":"Signer email address","description":"The email address of the signer.","type":"string","required":true},"templateId":{"id":"templateId","label":"Template ID","description":"Use the template id to create a SignatureRequest from a template.","type":"string","required":true},"subject":{"id":"subject","label":"Subject","description":"The subject in the email that will be sent to the signer.","type":"string","required":false},"message":{"id":"message","label":"Message","description":"The custom message in the email that will be sent to the signer.","type":"string","required":false}},"dataPoints":{"envelopeId":{"key":"envelopeId","valueType":"string"},"signUrl":{"key":"signUrl","valueType":"string"}},"previewable":false},"embeddedSigning":{"key":"embeddedSigning","title":"Embedded signing","description":"Let a stakeholder sign an embedded signature request with Awell Hosted Pages.","category":"Document Management","fields":{"signUrl":{"id":"signUrl","label":"Sign URL","description":"Enter the sign URL generated via the \"Create embedded signature request with template\" action","type":"string","required":true}},"dataPoints":{"signed":{"key":"signed","valueType":"boolean"}},"options":{"stakeholders":{"label":"Stakeholder","mode":"single"}},"previewable":false},"createSequentialEmbeddedSignatureRequest":{"key":"createSequentialEmbeddedSignatureRequest","title":"Create sequential embedded signature request","description":"Create an embedded signature request with sequential signing. Adds both Recipient 1 (routing order 1) and Recipient 2 (routing order 2) to the envelope, but only generates the Recipient 1 sign URL. Use \"Generate sign URL for existing envelope\" action after Recipient 1 signs to get the Recipient 2 URL.","category":"Document Management","fields":{"templateId":{"id":"templateId","label":"Template ID","description":"Use the template id to create a SignatureRequest from a template.","type":"string","required":true},"subject":{"id":"subject","label":"Subject","description":"The subject in the email that will be sent to the signers.","type":"string","required":false},"message":{"id":"message","label":"Message","description":"The custom message in the email that will be sent to the signers.","type":"string","required":false},"patientSignerRole":{"id":"patientSignerRole","label":"Recipient 1 signer role","description":"Must match an existing role in chosen template. It's case-sensitive. Recipient 1 will sign first.","type":"string","required":true},"patientSignerName":{"id":"patientSignerName","label":"Recipient 1 signer name","description":"The name of the first signer.","type":"string","required":true},"patientSignerEmail":{"id":"patientSignerEmail","label":"Recipient 1 signer email","description":"The email address of the first signer.","type":"string","required":true},"providerSignerRole":{"id":"providerSignerRole","label":"Recipient 2 signer role","description":"Must match an existing role in chosen template. It's case-sensitive. Recipient 2 will sign second, after Recipient 1.","type":"string","required":true},"providerSignerName":{"id":"providerSignerName","label":"Recipient 2 signer name","description":"The name of the second signer.","type":"string","required":true},"providerSignerEmail":{"id":"providerSignerEmail","label":"Recipient 2 signer email","description":"The email address of the second signer.","type":"string","required":true},"providerClientUserId":{"id":"providerClientUserId","label":"Recipient 2 client user ID","description":"Unique identifier for the second signer used for embedded signing. This should match the stakeholder ID in your care flow.","type":"string","required":true}},"dataPoints":{"envelopeId":{"key":"envelopeId","valueType":"string"},"recipient1SignUrl":{"key":"recipient1SignUrl","valueType":"string"}},"previewable":false},"generateSignUrlForExistingEnvelope":{"key":"generateSignUrlForExistingEnvelope","title":"Generate sign URL for existing envelope","description":"Generate a signing URL for a recipient that already exists in a DocuSign envelope. Use this after the previous signer completes in a sequential signing workflow.","category":"Document Management","fields":{"envelopeId":{"id":"envelopeId","label":"Envelope ID","description":"The ID of the existing DocuSign envelope. This is returned from the \"Create sequential embedded signature request\" action.","type":"string","required":true},"signerName":{"id":"signerName","label":"Signer name","description":"The name of the person who will sign the document. Must match the name of a recipient already in the envelope.","type":"string","required":true},"signerEmail":{"id":"signerEmail","label":"Signer email","description":"The email address of the person who will sign the document. Must match the email of a recipient already in the envelope.","type":"string","required":true},"clientUserId":{"id":"clientUserId","label":"Client user ID","description":"Unique identifier for the signer used for embedded signing. Must match the client user ID of a recipient already in the envelope.","type":"string","required":true}},"dataPoints":{"signUrl":{"key":"signUrl","valueType":"string"}},"previewable":false}},"webhooks":[],"description":"DocuSign makes your business faster, simpler and more cost-efficient with electronic agreements. Agree with confidence, with intuitive signing experiences across virtually any device.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1690539849/Awell%20Extensions/6345a42c2a73234ee04669dd_sig-icon.svg","title":"DocuSign","category":"Document Management","author":{"authorType":"Awell"},"settings":{"integrationKey":{"label":"Integration key (client ID)","key":"integrationKey","obfuscated":true,"required":true,"description":"An integration key identifies your integration and links to its configuration values. This can be obtained in your developer account from the Apps and Keys page"},"accountId":{"label":"API Account ID","key":"accountId","obfuscated":false,"required":true,"description":"A GUID value that identifies your account. This can be obtained in your developer account from the Apps and Keys page"},"userId":{"label":"Impersonated User ID (UserID)","key":"userId","obfuscated":false,"required":true,"description":"This is a GUID identifying the DocuSign user that you will be impersonating with the access token. Your own User ID can be found at the top of the Apps and Keys page."},"rsaKey":{"label":"RSA private key (in Base64 format)","key":"rsaKey","obfuscated":true,"required":true,"description":"This is for the integration key you obtained above and can also be created on the Apps and Keys page. You only need the private key, and it can only be copied once. Make sure to retain it for your records. Provide it in Base64 format - if you copy the key as is, it will not be valid as newlines and formatting won't be persisted."},"baseApiUrl":{"label":"Base API URL (DocuSign)","key":"baseApiUrl","obfuscated":false,"required":false,"description":"Base API URL for API calls matching your environment on DocuSign. Defaults to: https://demo.docusign.net. Remember that this URL MUST match the one you registered for your app in DocuSign settings. Can be obtained from Account Base URI section of the Apps and Keys page or the \"base_uri\" property in the response of a call to the \"/oauth/userinfo\""},"returnUrlTemplate":{"label":"Return URL template","key":"returnUrlTemplate","obfuscated":false,"required":false,"description":"Return URL for your application to which DocuSign will redirect the user after signing the document. Set when you self host your application. You can use {sessionId}, {pathwayId}, {activityId} and {stakeholderId} variables to construct the URL, where variables will be replaced with actual values. Defaults to: \"https://goto.development.awell.health/?sessionId={sessionId}\"."}}},{"key":"documo","htmlDocs":"\n
title: Documo
\ndescription: Documo extension for Awell
\nDocumo extension
\nDocumo extension for Awell that integrates with Documo's intelligent document processing platform.
\nWebhooks
\nOCR Document Completed
\nTriggered when OCR processing completes on a document. Uses an LLM to extract patient information from the OCR text.
\nData Points:
\n- \n
webhookData- Full webhook payload (JSON) \nextractedInfo- Extracted patient information (JSON) \n
Document Field Value Assigned
\nTriggered when a field value is assigned to a document. Extracts patient and provider information from the document field assignments.
\nData Points:
\n| Data Point | \nType | \nDescription | \n
|---|---|---|
webhookData | \njson | \nFull webhook payload | \n
patientFirstName | \nstring | \nPatient's first name | \n
patientLastName | \nstring | \nPatient's last name | \n
patientZipCode | \nstring | \nPatient's zip code | \n
patientIdentifiers | \njson | \nArray of patient identifiers (e.g., MRN, insurance ID) | \n
patientMobilePhone | \nstring | \nPatient's phone number | \n
receivingProviderFullName | \nstring | \nName of the receiving provider | \n
Field Mappings:
\nThe webhook maps Documo field names to data points:
\n| Documo Field Name | \nData Point | \n
|---|---|
| Patient First Name | \npatientFirstName | \n
| Patient Last Name | \npatientLastName | \n
| Patient Zip Code | \npatientZipCode | \n
| Patient Identifiers | \npatientIdentifiers | \n
| Patient Phone Number | \npatientMobilePhone | \n
| Receiving Provider Full Name | \nreceivingProviderFullName | \n
Settings
\n- \n
- Api Key: Documo API Key \n
Development
\nRunning Tests
\nTo run tests for a specific file:
\nyarn run test -- <file name>\nOr run all Documo tests:
\nyarn run test -- --testPathPattern='extensions/documo' --runInBand\nDocumo changelog
\n[Unreleased]
\n- \n
- Initial release \n
\n
title: Dropbox Sign
\ndescription: Dropbox Sign (formerly HelloSign) is the easiest way to send, receive and manage legally binding electronic signatures.
\nDropbox Sign
\nDropbox Sign (formerly HelloSign) is the easiest way to send, receive and manage legally binding electronic signatures.
\nExtension settings
\nIn order to set up this extension, you will need to provide the following settings:
\n- \n
- API Key \n
- Client ID - the id of the API app created in Dropbox Sign. Only required if want to use embedded signature requests. \n
- Test mode - whether you want to execute all API calls to DropboxSign in test mode. When test mode is enabled, signature requests will not be legally binding. When disabled, keep in mind that you must upgrade to a paid DropboxSign API plan to create signature requests via the extension. \n
Custom Actions
\nEmbedded signing
\nEmbedded Signing gives users the ability to sign documents directly from Awell Hosted Pages using Dropbox Sign's embedded signing feature. First an embedded signature request with a template is created and then a signing URL is generated for the signature request. Via the signing URL, we can let the user sign the request from within Awell.
\nEmbedded signing behaves as a blocking action where the action is only completed when the signature request is effectively signed.
\nIn order to add embedded signing, you need to add 2 actions to you care flow:
\n- \n
- First, add the \"Create embedded signature request with template\" action. This action will create an embedded signature request based on a template and return a sign URL. \n
- Second, add the \"Embedded signing\" action. In this action you will have to configure the sign URL you got from the first action. \n
Please note that the signing URL generated in the first step is only valid for 1 hour. This means that from as soon as the first action is activated, the user has 1 hour to complete the signing request. When the sign URL has expired, the document cannot be signed anymore and and the process would have to be repeated.
\nSend signature request with template
\nCreates and sends a new SignatureRequest based off of a template specified with the template id parameter. The request will be send to specified signer via email. Please note that is a non-blocking action and that the care flow will automatically continue once the request is sent. It won't wait for the actual signing of the request.
\nTo send signature requests via the DropboxSign API you must upgrade to a paid API plan.
\nGet signature request
\nReturns the SignatureRequest specified by the signature request id parameter.
\nSend request reminder
\nSends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders.
\nImportant:
\n- \n
- The email address specified to send the reminder to needs to be an email address of an actual signer linked to the signature request. If not, the action will fail. \n
- This action can not be used with embedded signature requests. \n
Cancel signature request
\nCancels an incomplete signature request. This action is not reversible.
","changelog":"Dropbox Sign changelog
","actions":{"sendSignatureRequestWithTemplate":{"key":"sendSignatureRequestWithTemplate","title":"Send signature request with template","description":"Send a signature request based off a template.","category":"Document Management","fields":{"signerRole":{"id":"signerRole","label":"Signer role","description":"Must match an existing role in chosen template. It's case-sensitive.","type":"string","required":true},"signerName":{"id":"signerName","label":"Signer name","description":"The name of the signer.","type":"string","required":true},"signerEmailAddress":{"id":"signerEmailAddress","label":"Signer email address","description":"The email address of the signer.","type":"string","required":true},"templateId":{"id":"templateId","label":"Template ID","description":"Use the template id to create a SignatureRequest from a template.","type":"string","required":true},"title":{"id":"title","label":"Title","description":"The title you want to assign to the SignatureRequest.","type":"string","required":false},"subject":{"id":"subject","label":"Subject","description":"The subject in the email that will be sent to the signer.","type":"string","required":false},"message":{"id":"message","label":"Message","description":"The custom message in the email that will be sent to the signer.","type":"string","required":false},"signingRedirectUrl":{"id":"signingRedirectUrl","label":"Signer redirect URL","description":"The URL you want signer redirected to after they successfully sign.","type":"string","required":false}},"dataPoints":{"signatureRequestId":{"key":"signatureRequestId","valueType":"string"}},"previewable":false},"sendRequestReminder":{"key":"sendRequestReminder","title":"Send request reminder","description":"Sends an email to the signer reminding them to sign the signature request.","category":"Document Management","fields":{"signatureRequestId":{"id":"signatureRequestId","label":"Signature request ID","description":"The id of the SignatureRequest to send a reminder for.","type":"string","required":true},"signerEmailAddress":{"id":"signerEmailAddress","label":"Signer email address","description":"The email address of the signer to send a reminder to.","type":"string","required":true}},"previewable":true},"cancelSignatureRequest":{"key":"cancelSignatureRequest","title":"Cancel signature request","description":"Cancels an incomplete signature request. This action is not reversible.","category":"Document Management","fields":{"signatureRequestId":{"id":"signatureRequestId","label":"Signature request ID","description":"The id of the SignatureRequest to cancel. Please note you can only cancel incomplete signature requests.","type":"string","required":true}},"previewable":false},"getSignatureRequest":{"key":"getSignatureRequest","title":"Get signature request","description":"Get details about a signature request.","category":"Document Management","fields":{"signatureRequestId":{"id":"signatureRequestId","label":"Signature request ID","description":"The id of the SignatureRequest you want to retrieve the details for.","type":"string","required":true}},"dataPoints":{"title":{"key":"title","valueType":"string"},"originalTitle":{"key":"originalTitle","valueType":"string"},"subject":{"key":"subject","valueType":"string"},"message":{"key":"message","valueType":"string"},"signingUrl":{"key":"signingUrl","valueType":"string"},"signingRedirectUrl":{"key":"signingRedirectUrl","valueType":"string"},"detailsUrl":{"key":"detailsUrl","valueType":"string"},"requesterEmailAddress":{"key":"requesterEmailAddress","valueType":"string"},"signerEmailAddress":{"key":"signerEmailAddress","valueType":"string"},"signerName":{"key":"signerName","valueType":"string"},"signerRole":{"key":"signerRole","valueType":"string"},"statusCode":{"key":"statusCode","valueType":"string"}},"previewable":true},"createEmbeddedSignatureRequestWithTemplate":{"key":"createEmbeddedSignatureRequestWithTemplate","title":"Create embedded signature request with template","description":"Let a stakeholder sign a request within Awell based off a template. The care flow will not progress until the request is signed.","category":"Document Management","fields":{"signerRole":{"id":"signerRole","label":"Signer role","description":"Must match an existing role in chosen template. It's case-sensitive.","type":"string","required":true},"signerName":{"id":"signerName","label":"Signer name","description":"The name of the signer.","type":"string","required":true},"signerEmailAddress":{"id":"signerEmailAddress","label":"Signer email address","description":"The email address of the signer.","type":"string","required":true},"templateId":{"id":"templateId","label":"Template ID","description":"Use the template id to create a SignatureRequest from a template.","type":"string","required":true},"title":{"id":"title","label":"Title","description":"The title you want to assign to the SignatureRequest.","type":"string","required":false},"subject":{"id":"subject","label":"Subject","description":"The subject in the email that will be sent to the signer.","type":"string","required":false},"message":{"id":"message","label":"Message","description":"The custom message in the email that will be sent to the signer.","type":"string","required":false},"customFields":{"id":"customFields","label":"Custom fields","description":"An array defining values and options for custom fields.","type":"json","required":false}},"dataPoints":{"signatureRequestId":{"key":"signatureRequestId","valueType":"string"},"signUrl":{"key":"signUrl","valueType":"string"},"expiresAt":{"key":"expiresAt","valueType":"date"}},"previewable":false},"embeddedSigning":{"key":"embeddedSigning","title":"Embedded signing","description":"Let a stakeholder sign an embedded signature request with Awell Hosted Pages.","category":"Document Management","fields":{"signUrl":{"id":"signUrl","label":"Sign URL","description":"Enter the sign URL generated via the \"Create embedded signature request with template\" action","type":"string","required":true}},"dataPoints":{"signed":{"key":"signed","valueType":"boolean"}},"options":{"stakeholders":{"label":"Stakeholder","mode":"single"}},"previewable":false}},"webhooks":[],"description":"Dropbox Sign (formerly HelloSign) is the easiest way to send, receive and manage legally binding electronic signatures.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1680191271/Awell%20Extensions/dropboxsign.png","title":"Dropbox Sign","category":"Document Management","author":{"authorType":"Awell"},"settings":{"apiKey":{"label":"API Key","key":"apiKey","obfuscated":true,"required":true,"description":"Enter an API key so Awell can communicate with the Dropbox Sign API."},"clientId":{"label":"Client ID","key":"clientId","obfuscated":false,"required":true,"description":"The client ID of the app created in Dropbox Sign."},"testMode":{"label":"Test mode","key":"testMode","obfuscated":false,"required":false,"description":"Set to \"Yes\" if you want to execute all API calls to DropboxSign in test mode. Set to \"No\" if you want to disable test mode. Keep in mind that when test mode is disabled, you must upgrade to a paid DropboxSign API plan to create signature requests. Defaults to \"No\"."}}},{"key":"elation","htmlDocs":"\n
title: Elation
\ndescription: Elation is a cloud-based health record system designed for healthcare providers, clinics, and medical practices.
\nElation
\nElation is a cloud-based health record system designed for healthcare providers, clinics, and medical practices. It offers a range of features including patient scheduling, charting, e-prescribing, billing, and telemedicine. Overall, Elation is designed to streamline the workflow of medical practices, improve patient care, and increase efficiency.
\nSetup
\nWebhooks
\nThe integration of webhooks with Elation presents unique challenges and considerations:
\n- \n
- Non-Discriminative Triggers: Elation does not differentiate between the creation or update of a resource. Both actions will set off webhook with action
saved, which might not provide enough discriminative information for some use cases. \n - Programmatic Setup: Elation webhooks can only be configured programmatically, as there's no dedicated user interface in Elation to set up webhooks. View this demo video for a step-by-step guide on how to set up your webhooks in Elation. \n
- Limitation on user-triggered actions: Elation has a concept called \"Preventing echo\". This means that that any action carried out by the user affiliated with the API credentials that created the subscription doesn't trigger a webhook. You can read more about this behaviour here. If you are not receiving any webhooks from Elation after setting up your subscription, then this is the reason. A feasible workaround to the above limitation is creating a dedicated user not meant for human interactions but serves the sole purpose of facilitating M2M communication. \n
If you need help setting up your webhooks in Elation, reach out! We are happy to help you.
\nExtension settings
\nIn order to use this extension you will need to provide the extension with the following settings:
\n- \n
- Base URL / endpoint URL of the API \n
- Authorization URL \n
- Client ID for OAuth2 Password authentication \n
- Client Secret for OAuth2 Password authentication \n
- API Username for OAuth2 Password authentication \n
- API Password for OAuth2 Password authentication \n
Not sure where you can find all of this information? Click here to have a look at Elation's Developer documentation.
\nActions
\nThe following actions are supported with Elation today:
\nCreate Patient
\nThis action creates a patient in Elation.
\nWhen creating a patient, you will have to specifiy the primary physician and caregiver practice ID:
\n- \n
- Primary physician ID: you can retrieve this ID by using the Find Physicians API call, or by using the
Find Physicianaction \n - Caregiver Practice ID: similar to the primary physician ID, you can find this ID by using the same API call or action \n
If the Elation API throws an error indicating the patient with the provided information already exists, the action will succeed and the ID of the existing patient will be returned.
\nGet Patient
\nUsing a patient identifier, retrieve a patient object from Elation.
\nNote that when retrieve the mobile phone number, we are tranforming the number to an international format. We apply a heuristic and assume all mobile numbers in Elation are in US national format so we prepend the number with the +1 country code. Having the number in international format unlocks more powerful functionality like sending text messages with 3rd party services like Twilio and MessageBird.
\nUpdate Patient
\nUpdate a patient in Elation using any fields available in create patient. We use Elation's PATCH method to apply partial modifications to a the patient resource (i.e. update only what is needed).
Create Appointment
\nEasily create a patient appointment in Elation.
\nCreating an appointment requires a few strings to be well-formulated:
\n- \n
Scheduled datemust be a datetime string (ISO-8601). For example, January 1, 2023 at noon, Pacific Time (-8 hours) would be shown as such:2023-01-01T12:00:00.000-08:00\nReasonmust not be free text. This value comes from the following list of appointment types (Follow-Up,Office Visit,Physical Exam, etc.):\n![\"Appointment](\"./assets/elation-appointment-reason.png?raw=true\" "\\"Elation")
\nPatientis the patient ID. \nPhysicianis the physician ID (seeFind Physician) \nPracticeis the practice ID (again, seeFind Physician) \n
You can also include a duration (default to 15 minutes, or whatever has been set in your EHR)
\nGet Appointment
\nRetrieve appointment details using an appointment ID.
\nCreate Non-Visit Note
\nThe non-visit note is a special kind of note that, as the name suggests, is not associated with a visit. These notes, in their simplest form, provide a chronological account of information about the patient.
\nAdditional documentation for some of the action fields:
\n- \n
- Category: The default category is \"Problem\" but you can choose any of \"Past\", \"Family\", \"Social\", \"Instr\", \"PE\", \"ROS\", \"Med\", \"Data\", \"Assessment\", \"Test\", \"Tx\", \"Narrative\", \"Followup\", \"Reason\", \"Plan\", \"Objective\", \"Hpi\", \"Allergies\", \"Habits\", \"Assessplan\", \"Consultant\", \"Attending\", \"Dateprocedure\", \"Surgical\", \"Orders\", \"Referenced\", \"Procedure\". \n
- Chart and document date automatically get set to the current date, i.e. the date when the action is orchestrated. \n
Delete Non-Visit Note
\nDeletes the non-visit note identified by an ID.
\nGet Non-Visit Note
\nRetrieve the details of a non-visit note identified by an ID.
\nGet physician
\nUsing a physician identifier, retrieve a physician object from Elation.
\nFind physicians
\nSearch a physician based on a set of parameters. The ID of the physician matching the search parameters will be returned. To retrieve the details of the physician, you can use the the \"Get physician\" action.
\nNote that this action can only support finding one physician so if your search criteria match multiple physicians the action will throw an error.
\n✨ Find Future Appointment
\nThis AI-powered action finds a single future appointment for a patient based on a prompt in natural language. Just type something like \"next cardiology appointment\" — AI figures it out and finds the matching appointment for you.
\nHow it works:
\n- \n
- All future appointments with status
ScheduledorConfirmedfor the patient are retrieved from Elation. \n - Based on the provided prompt, an LLM tries to find a single appointment from the list of future appointments that matches the prompt. \n
- If multiple appointments exist that match the instructions, only the first one is returned. \n
What it needs (Inputs):
\n- \n
Elation patient ID(Required): The numeric ID of the patient in Elation whose appointments you want to search. \nDescribe what appointment you would like to find(Required): A natural language description of the appointment you're looking for. Be as specific as possible about the type, status, timing, or any other important aspect for your use case. \n
What it gives back (Outputs):
\n- \n
Appointment: The complete appointment data in JSON format (if found). \nAppointment Exists: Boolean indicator (true/false) of whether a matching appointment was found. \nExplanation: A clear explanation of why the selected appointment was chosen or why no appointment was found. \n
Tips for best results:
\n- \n
- Include specific details about the appointment type, status, or purpose in your description. \n
- Use single or double quotes for exact matches. For example, if you search for '\"Physical Exam\"', the action will search for appointments with that exact appointment type (with small variations physical exams, Physical exam). \n
- When you know exactly what to match (status, physician name, appointment type), put it in quotes (e.g., '\"Scheduled\"', '\"Follow-Up\"') for exact matching. \n
- For other criteria where you're less certain, provide descriptive instructions without quotes, for example all physical exams - then AI action will try to find all exams that can be classified as physical exams. \n
- Time-based instructions work well, such as \"next week,\" \"this month,\" or \"next Thursday.\" \n
- If multiple appointments match your criteria, only the first one will be returned. \n
- Be clear and specific in your instructions to avoid ambiguity - this is critical for getting accurate results. \n
Example:
\nInput:\n Elation patient ID: 12345\n Describe what appointment you would like to find: \"Find my next video appointment with status 'Confirmed' for 'Follow-Up'\"\n\nOutput:\n Appointment: {\n \"id\": 67890,\n \"scheduled_date\": \"2023-08-15T14:30:00Z\",\n \"status\": {\n \"status\": \"Confirmed\"\n },\n \"mode\": \"VIDEO\",\n \"reason\": \"Follow-Up\"\n }\n Appointment Exists: true\n Explanation: \"I found a video appointment scheduled for August 15, 2023 at 2:30 PM. The appointment is confirmed and is for a Follow-Up visit, which matches your search criteria. This is the earliest upcoming confirmed video appointment for a follow-up.\"\n✨ Find Appointments
\nThis AI-powered action finds all appointments for a patient based on a prompt in natural language. Want to know how many mental health sessions someone has had this year? Just ask — AI returns them all.
\nHow it works:
\n- \n
- All appointments, independent of their date or status, for the patient are retrieved from Elation. \n
- Based on the provided prompt, an LLM tries to find all appointments from the list of appointments that match the prompt. \n
What it needs (Inputs):
\n- \n
Elation patient ID(Required): The numeric ID of the patient in Elation whose appointments you want to search. \nDescribe the appointments to search for(Required): A natural language description of the appointments you're looking for. Be as specific as possible about appointment types, timing, status, or other criteria. \n
What it gives back (Outputs):
\n- \n
Appointments: Array of appointment objects that match your search criteria (in JSON format). \nExplanation: A detailed explanation of why these appointments were selected, including the reasoning behind the matches. \nAppointment Counts By Status: A summary of how many matching appointments were found in each status category (e.g., \"Scheduled\": 2, \"Completed\": 1). \n
Tips for best results:
\n- \n
- When you know exactly what to match (status, appointment type), put it in quotes (e.g., '\"Scheduled\"', '\"Office Visit\"') for exact matching. \n
- For other criteria where you're less certain, provide descriptive instructions without quotes. \n
- Include specific time ranges, such as \"all appointments in 2023\" or \"appointments from January to March\" when relevant. \n
- Filter by appointment status: \"Cancelled,\" \"Completed,\" \"Scheduled,\" or \"Confirmed\" when relevant. \n
- Be clear and specific in your instructions and avoid ambiguity - this is critical for getting accurate results. \n
Example:
\nInput:\n Elation patient ID: 12345\n Describe the appointments to search for: \"Find all completed appointments with type 'Physical Exam' in the last 6 months\"\n\nOutput:\n Appointments: [\n {\n \"id\": 67890,\n \"scheduled_date\": \"2023-06-10T13:00:00Z\",\n \"status\": {\n \"status\": \"Completed\"\n },\n \"reason\": \"Physical Exam\",\n \"mode\": \"IN_PERSON\"\n },\n {\n \"id\": 67891,\n \"scheduled_date\": \"2023-03-15T09:30:00Z\",\n \"status\": {\n \"status\": \"Completed\"\n },\n \"reason\": \"Physical Exam\",\n \"mode\": \"IN_PERSON\"\n }\n ]\n Explanation: \"I found 2 completed physical exam appointments in the last 6 months. The first appointment was on June 10, 2023, and the second appointment was on March 15, 2023. Both appointments were in-person and are marked as completed in the system.\"\n Appointment Counts By Status: {\n \"Completed\": 2\n }\n✨ Cancel Appointments
\nThis AI-powered action uses AI to identify and cancel patient appointments based on natural language instructions. You can say, \"All follow-up appointments for next week\" and AI will identify and cancel the right ones for you.
\nHow it works:
\n- \n
- Retrieves all upcoming appointments for the patient from Elation \n
- Uses an LLM to interpret the prompt and identify which appointments should be canceled \n
- Processes the cancellation for matched appointments and handles partial success scenarios \n
What it needs (Inputs):
\n- \n
Elation patient ID(Required): The numeric ID of the patient in Elation whose appointments you want to cancel. \nDescribe the appointments you would like to cancel(Required): Natural language instructions describing which appointments should be canceled. Be specific about criteria such as time period, appointment type, or provider. \n
What it gives back (Outputs):
\n- \n
Cancelled Appointments: An array of appointment IDs that were successfully canceled. \nExplanation: A detailed explanation of which appointments were canceled and why they matched your criteria. \n
Tips for best results:
\n- \n
- Use single or double quotes for exact matches. For example, '\"Follow-Up\"' will only match appointments with exactly that type. \n
- When you know exactly what to match (appointment type, status), put it in quotes (e.g., '\"Scheduled\"', '\"Physical Exam\"') for exact matching. \n
- For other criteria where you're less certain, provide descriptive instructions without quotes. \n
- Be specific about the time frame: \"all appointments this week,\" \"appointments in July,\" etc. \n
- You can target specific appointment types: \"all physical therapy appointments,\" \"follow-up visits\", etc. \n
- Only future appointments with status \"Scheduled\" or \"Confirmed\" can be canceled. \n
- If no appointments match your criteria, the action will explain why nothing was canceled. \n
- For safety, highly specific criteria are recommended to avoid unintended cancellations. \n
- Be clear and specific in your instructions to avoid ambiguity - this is critical for preventing accidental cancellations. \n
Example:
\nInput:\n Elation patient ID: 12345\n Describe the appointments you would like to cancel: \"All appointments with status 'Scheduled' for office visits in the next two weeks.\"\n\nOutput:\n Cancelled Appointments: [67890, 67891]\n Explanation: \"I canceled 2 appointments based on your request:\n 1. Appointment #67890: Scheduled for June 5, 2023 at 2:00 PM, type: Office Visit\n 2. Appointment #67891: Scheduled for June 12, 2023 at 10:30 AM, type: Office Visit\n\n Both appointments were within the next two weeks and match the 'Office Visit' type and 'Scheduled' status as specified. The appointments were successfully canceled in the system and will need to be rescheduled after the patient returns from vacation.\"\n✨ Update Patient Tags
\nThis AI-powered action uses AI to manage patient tags in Elation based on natural language instructions. Want to mark someone for special attention? Just say it, and AI updates their tags in Elation.
\nHow it works:
\n- \n
- Retrieves existing patient tags from Elation \n
- Uses an LLM to interpret natural language instructions and determine required tag changes \n
- Updates patient tags in Elation according to the interpreted changes \n
What it needs (Inputs):
\n- \n
Elation patient ID(Required): The numeric ID of the patient in Elation whose tags you want to update. \nSpecify tags to add, remove, or modify(Required): Natural language instructions explaining what tag changes you want to make. Be specific about which tags to add, remove, or modify. \n
What it gives back (Outputs):
\n- \n
Updated Tags: A comma-separated list of all patient tags after your requested changes have been applied. \nExplanation: A detailed explanation of what changes were made to the tags and why. \n
Tips for best results:
\n- \n
- When specifying new tags to add, use single quotes around tag names (e.g., 'Diabetes', 'High-Risk') for exact matching. \n
- Case sensitivity and exact spelling matter when using quotes - 'Diabetes' and 'diabetes' will be treated as different tags. \n
- Be explicit about which tags to remove or replace (e.g., \"Remove the 'Temporary' tag\"). \n
- You can include context to help the AI understand why tags are being modified. \n
- To clear all tags, you can say \"Remove all tags\" or \"Clear all existing tags.\" \n
- Due to Elation API limitations, clearing all tags is implemented by setting a single space tag (' '). This is the recommended workaround from Elation's team. \n
- Tags must already exist in your Elation database to be added. \n
- Be clear and specific in your instructions to avoid ambiguity - this is critical for getting accurate results. \n
Example:
\nInput:\n Elation patient ID: 12345\n Specify tags to add, remove, or modify: \"Add the tags 'Diabetes' and 'CCM Program'. Remove the 'Inactive' tag if it exists.\"\n\nOutput:\n Updated Tags: \"Diabetes, CCM Program, Hypertension\"\n Explanation: \"I've made the following changes to the patient's tags:\n 1. Added 'Diabetes' tag as requested\n 2. Added 'CCM Program' tag as requested\n 3. No 'Inactive' tag was found, so no removal was necessary\n 4. The existing 'Hypertension' tag was preserved\"\n✨ Check Patient Tags
\nThis AI-powered action uses AI to check if a patient's tags match given instructions in natural language. Ask \"Is this patient marked as 'Diabetic' or 'Obese'?\" — AI checks and explains the answer.
\nHow it works:
\n- \n
- Retrieves existing patient tags from Elation \n
- Uses an LLM to interpret natural language instructions and check if the patient's tags match the requirements \n
- Returns a boolean result and explanation of the check \n
What it needs (Inputs):
\n- \n
Elation patient ID(Required): The numeric ID of the patient in Elation whose tags you want to check. \nInstructions for checking tags(Required): Natural language instructions explaining what tag conditions you want to verify. Be specific about what tags should or shouldn't be present. \n
What it gives back (Outputs):
\n- \n
Tags Found: Boolean (true/false) indicating whether the patient's tags match your specified criteria. \nExplanation: A detailed explanation of why the tags match or don't match your criteria, including which tags were found or missing. \n
Tips for best results:
\n- \n
- When specifying exact tag matches, use double quotes around tag names (e.g., \"Diabetes\", \"High-Risk\") for exact matching. \n
- Case sensitivity and exact spelling matter when using quotes - \"Diabetes\" and \"diabetes\" will be treated as different tags. \n
- You can use logical operators in your instructions, such as AND, OR, NOT (e.g., \"Check if the patient has 'Diabetes' AND 'Hypertension' tags\"). \n
- Complex conditions are supported, like \"either/or\", \"both\", \"not\", \"any of\", \"none of\". \n
- Be precise about what combination of tags you're looking for to get accurate results. \n
- The action provides reasoning about why the criteria was or wasn't met, which can be useful for debugging or explaining decisions. \n
- Be clear and specific in your instructions to avoid ambiguity - this is critical for getting accurate results. \n
Example:
\nInput:\n Elation patient ID: 12345\n Instructions for checking tags: \"Check if the patient has the tag 'CCM Program' but does not have the tag 'Excluded'. They need to be in the CCM program without exclusions to be eligible for our new service.\"\n\nOutput:\n Tags Found: true\n Explanation: \"The patient meets the specified criteria. They have the 'CCM Program' tag, indicating enrollment in the Chronic Care Management program. They do not have the 'Excluded' tag. The patient's complete tag list is: CCM Program, Diabetes, Hypertension. Based on these tags, the patient is eligible for the new service as they are in the CCM program without exclusions.\"\nElation Changelog
\nJanuary 30, 2024
\n- \n
- New actions \n
- Post letter: Using patient and practice identifier, post a new letter to either Provider, Patient or associate it with an existing Referral. \n
October 3, 2023
\n- \n
- The README is now more concise with less unneeded detail. A section on the particularities of Elation subscriptions (webhooks) was added. \n
- Misc. updates to labels, descriptions, action fields order \n
- Action updates \n
- Create Non-Visit Note:
- \n
- Simplify the action by removing some optional action fields (we can always expand later) \n
document_dateandchart_dateare now automatically set to the date of today so that the corresponding action fields could be removed
\n - Create patient
- \n
dobis now adatefield type (was a string) \n- You can pass a mobile phone number and email when creating a patient
\n - Find physician
- \n
- Only returns the physician ID instead of all the details of the physician. To retrieve the details one can use the new
Get physicianaction
\n - Only returns the physician ID instead of all the details of the physician. To retrieve the details one can use the new
- Update patient
- \n
dobis now adatefield type (was a string) \n- We are now using
PATCHinstead ofPUTwhich allows for a partial update, i.e. only update the fields that are needed.
\n - New actions \n
- Get physician: Using a physician identifier, retrieve a physician object from Elation. \n
- Removed actions \n
- Update Non-Visit Note \n
- Webhooks \n
- Fix the type of
patientIdinpatientCreatedOrUpdatedwebhook \n - Added
appointmentCreatedOrUpdatedwebhook \n
September 4, 2023
\n- \n
- rename
onCreatePatientwebhook topatientCreatedOrUpdated\n - filter non
savedactions for this webhook \n
August 21, 2023
\n- \n
- make non-visit note text a large input (
StringType.TEXT) \n
May 23, 2024
\n- \n
- add patient_status.status to patient object in getPatient action \n
- add status to updatePatient action \n
\n
title: Epic
\ndescription: Epic is an Electronic Health Records (EHR) system for healthcare organizations, hospitals and large practices.
\nEpic
\nEpic is an Electronic Health Records (EHR) system for healthcare organizations, hospitals and large practices.
\nIntroduction
\nIntegration landscape
\nEpic provides a comprehensive range of interfaces for integration. We've grouped them into four key categories:
\n- \n
- Read: Retrieve data from Epic (e.g., patient demographics). \n
- Write: Send data to Epic (e.g., create a patient, create a document). \n
- Subscriptions/Events: Subscribe to events in Epic. \n
- Embedded Apps: Embed applications within Epic, SSO launch, and more (typically via SMART-on-FHIR). \n
Each category offers multiple interfaces tailored to specific workflows and use cases.
\nWe seamlessly integrates with Epic across all categories using industry-standard protocols like HL7, FHIR, and proprietary APIs. We prioritize trust and flexibility, supporting both REST and non-REST interfaces to meet your organization's needs.
\nThe Epic extension
\nThe Epic Extension is designed to support Read and Write integrations via SMART Backend Services. These integrations are server-to-server (backend) and do not require direct user interaction—whether from patients or practitioners.
\nThe extension supports a variety of REST-based interfaces, including:
\n- \n
- Vendor Services API \n
- FHIR R4 \n
- FHIR DSTU2 \n
- FHIR STU3 \n
In addition to REST interfaces, Epic also supports non-REST standards like HL7, enabling tasks such as querying patient demographics (ADR A19) or creating documents (ORU messages). Awell supports these non-REST standards as well. However, the Epic Extension focuses specifically on REST-based interfaces.
\nSetup
\nTo set up the Epic Extension in Awell, you’ll need to configure the following:
\n- \n
- Base URL: The Epic instance's base URL (e.g.,
https://fhir.epic.com/interconnect-fhir-oauth/api/). \n - Auth URL: The URL for obtaining access tokens (e.g.,
https://fhir.epic.com/interconnect-fhir-oauth/oauth2/token). \n - Client ID: The client ID of Awell’s registered Epic application. \n
- Private Key: The private key for the application, formatted as a single string with new lines explicitly indicated by
\\n. \n
Example of Private Key Format:\n-----BEGIN PRIVATE KEY-----\\naaaaaaa\\nbbbbb\\n-----END PRIVATE KEY-----
Actions
\nGet patient (R4)
\nRetrieve a patient’s details using their FHIR resource ID. This action returns the full FHIR Patient resource.
\nMatch patient (R4)
\nFind a patient using demographic data. The action returns a matching Patient resource only if a single high-confidence match is found.
\n- \n
- If multiple high-confidence matches or no matches are found, the action fails. \n
- This uses the
Patient.$match(R4) operation, recommended for backend-to-backend integrations (learn more: Epic Documentation). \n
The action will return the FHIR resource ID of the matched patient.
\nCreate patient (R4)
\nAdd a new patient to Epic using demographic information. Required fields include:
\n- \n
- SSN \n
- Given name \n
- Family name \n
- Gender \n
- Birth date \n
While optional, including an email address is highly recommended to improve accuracy when matching patients in the future.
\nThe action will return the FHIR resource ID of the created patient.
\nGet appointment
\nRetrieve details of a specific appointment using its FHIR resource ID. The action returns the full FHIR Appointment resource.
\nCreate clinical note (R4)
\nCreate a clinical document in Epic. Required fields include:
\n- \n
- Patient resource ID: The patient’s FHIR resource ID. \n
- Encounter resource ID: The related encounter’s FHIR resource ID (currently required; Pre-Charting support is coming February 2025). \n
- Document status: The status of the document. \n
- Document type: The type of the document. \n
- Document content: The content of the document. \n
The action will return the FHIR resource ID of the created document.
\nFind patient by MRN (R4)
\nLeverages the Patient.search (R4) operation to find a patient by their MRN. The action will return the FHIR resource ID of the patient.
Epic changelog
","actions":{"getPatient":{"key":"getPatient","title":"Get patient","description":"Retrieve patient details from Epic","category":"EHR Integrations","fields":{"resourceId":{"id":"resourceId","label":"Patient resource ID","description":"The resource ID of the patient","type":"string","required":true}},"previewable":true,"dataPoints":{"patient":{"key":"patient","valueType":"json"},"officialGivenName":{"key":"officialGiveName","valueType":"string"},"officialFamilyName":{"key":"officialFamilyName","valueType":"string"},"birthDate":{"key":"birthDate","valueType":"date"}}},"getAppointment":{"key":"getAppointment","title":"Get appointment","description":"Retrieve appointment details from Epic","category":"EHR Integrations","fields":{"resourceId":{"id":"resourceId","label":"Patient resource ID","description":"The resource ID of the patient","type":"string","required":true}},"previewable":true,"dataPoints":{"appointment":{"key":"appointment","valueType":"json"},"patientId":{"key":"patientId","valueType":"string"},"appointmentStatus":{"key":"appointmentStatus","valueType":"string"},"appointmentStartDateTime":{"key":"appointmentStartDateTime","valueType":"date"},"appointmentTypeCode":{"key":"appointmentTypeCode","valueType":"string"}}},"createPatient":{"key":"createPatient","title":"Create patient","description":"Create a patient in Epic","category":"EHR Integrations","fields":{"ssn":{"id":"ssn","label":"SSN","type":"string","description":"The patient’s Social Security Number.","required":true},"familyName":{"id":"familyName","label":"Family name","type":"string","description":"The patient’s family (last) name.","required":true},"givenName":{"id":"givenName","label":"Given name","type":"string","description":"The patient's given name. May include first and middle names.","required":true},"birthDate":{"id":"birthDate","label":"Birth date","type":"date","required":true},"gender":{"id":"gender","label":"Gender","type":"string","required":true,"options":{"dropdownOptions":[{"value":"male","label":"Male"},{"value":"female","label":"Female"},{"value":"other","label":"Other"},{"value":"unknown","label":"Unknown"}]}},"email":{"id":"email","label":"Email","type":"string","required":false}},"previewable":true,"dataPoints":{"resourceId":{"key":"resourceId","valueType":"string"}}},"createClinicalNote":{"key":"createClinicalNote","title":"Create clinical note","description":"Create a clinical note in Epic","category":"EHR Integrations","fields":{"patientResourceId":{"id":"patientResourceId","label":"Patient resource ID","type":"string","description":"The patient’s FHIR resource ID.","required":true},"encounterResourceId":{"id":"encounterResourceId","label":"Encounter resource ID","description":"The FHIR resource ID of the related encounter.","type":"string","required":true},"status":{"id":"status","label":"Document status","type":"string","required":true,"options":{"dropdownOptions":[{"value":"final","label":"Final"},{"value":"preliminary","label":"Preliminary"}]}},"type":{"id":"type","label":"Document type","type":"string","required":true,"options":{"dropdownOptions":[{"value":"Progress Note","label":"Progress Note"},{"value":"Consult Note","label":"Consult Note"},{"value":"Procedure Note","label":"Procedure Note"},{"value":"H&P Note","label":"H P Note"},{"value":"Discharge Summary","label":"Discharge Summary"},{"value":"ED Note","label":"ED Note"},{"value":"Patient Instructions","label":"Patient Instructions"},{"value":"Nursing Note","label":"Nursing Note"}]}},"note":{"id":"note","label":"Note","type":"text","required":true}},"previewable":true,"dataPoints":{"resourceId":{"key":"resourceId","valueType":"string"}}},"matchPatient":{"key":"matchPatient","title":"Match patient","description":"Match patient to existing patient in Epic","category":"EHR Integrations","fields":{"familyName":{"id":"familyName","label":"Family name","type":"string","description":"The patient’s family (last) name.","required":true},"givenName":{"id":"givenName","label":"Given name","type":"string","description":"The patient's given name. May include first and middle names.","required":true},"birthDate":{"id":"birthDate","label":"Birth date","type":"date","required":true},"gender":{"id":"gender","label":"Gender","type":"string","required":true,"options":{"dropdownOptions":[{"value":"male","label":"Male"},{"value":"female","label":"Female"},{"value":"other","label":"Other"},{"value":"unknown","label":"Unknown"}]}},"email":{"id":"email","label":"Email","type":"string","required":true}},"previewable":true,"dataPoints":{"resourceId":{"key":"resourceId","valueType":"string"}}},"findPatientByMRN":{"key":"findPatientByMRN","title":"Find patient by MRN","description":"Find patient by MRN in Epic","category":"EHR Integrations","fields":{"MRN":{"id":"MRN","label":"Medical Record Number (MRN)","type":"string","description":"","required":true}},"previewable":true,"dataPoints":{"resourceId":{"key":"resourceId","valueType":"string"}}},"getClinicalNote":{"key":"getClinicalNote","title":"Get clinical note","description":"Retrieve clinical note details from Epic","category":"EHR Integrations","fields":{"resourceId":{"id":"resourceId","label":"Document reference resource ID","description":"Document reference resource ID of the clinical note","type":"string","required":true}},"previewable":true,"dataPoints":{"documentReference":{"key":"documentReference","valueType":"json"},"binaryContentHtml":{"key":"binaryContentHtml","valueType":"string"},"binaryContentRtf":{"key":"binaryContentRtf","valueType":"string"}}}},"webhooks":[],"description":"Epic is an Electronic Health Records (EHR) system for healthcare organizations, hospitals and large practices.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1736327686/Awell%20Extensions/epiclogo_2_1.webp","title":"Epic","category":"EHR Integrations","author":{"authorType":"Awell"},"settings":{"baseUrl":{"key":"baseUrl","label":"Base URL","required":true,"obfuscated":false,"description":"The base URL for the Epic API, e.g. https://fhir.epic.com/interconnect-fhir-oauth/api"},"authUrl":{"key":"authUrl","label":"Auth URL","required":true,"obfuscated":false,"description":"The auth URL for the Epic API, e.g. https://fhir.epic.com/interconnect-fhir-oauth/oauth2/token"},"clientId":{"key":"clientId","label":"Client ID","required":true,"obfuscated":false,"description":"The client ID of the Epic app used to authenticate."},"privateKey":{"key":"privateKey","label":"Private Key","required":true,"obfuscated":true,"description":"The private key of the Epic app used to authenticate."},"kid":{"key":"kid","label":"KID","required":false,"obfuscated":false,"description":"For apps using JSON Web Key Sets (including dynamically registed clients), set this value to the kid of the target public key from your key set"},"jku":{"key":"jku","label":"JKU","required":false,"obfuscated":false,"description":"For apps using JSON Web Key Set URLs, optionally set this value to the URL you registered on your application"}}},{"key":"experimental","htmlDocs":"\n
title: Experimental extension
\ndescription: Extension for experimental purposes
\nExperimental extension
","changelog":"Changelog
","actions":{"requestVideoVisit":{"key":"requestVideoVisit","title":"Request video visit","description":"Allow user to choose between requesting a video visit or simply continue","category":"Workflow","fields":{"deepLink":{"id":"deepLink","label":"Deep link","description":"Insert a deep link for testing","type":"string","required":false}},"dataPoints":{"requestVideoVisit":{"key":"requestVideoVisit","valueType":"boolean"}},"options":{"stakeholders":{"label":"Stakeholder","mode":"single"}},"previewable":false},"wait":{"key":"wait","title":"Wait","description":"Wait n number of seconds before completing","category":"Workflow","fields":{"seconds":{"id":"seconds","label":"Seconds","description":"Number of seconds to wait before this action will be completed","type":"numeric","required":true}},"dataPoints":{},"previewable":true},"patientRecommendation":{"key":"patientRecommendation","title":"Patient recommendation","description":"Recommend the patient with an office visit, video chat, ...","category":"Workflow","fields":{"title":{"id":"title","label":"Title","description":"Descriptive title that is shown on the page","type":"string","required":true},"message":{"id":"message","label":"Message","description":"Inform the patient about the recommendation and decision they have to make","type":"html","required":true},"acceptRecommendationButtonLabel":{"id":"acceptRecommendationButtonLabel","label":"Accept recommendation button label","description":"The label of the buton to accept the recommendation and redirect the patient to a different page with a deep link","type":"string","required":true},"acceptRecommendationDeepLink":{"id":"acceptRecommendationDeepLink","label":"Deep link","description":"The deep link the patient is redirected to when accepting the recommendation","type":"string","required":true},"discardRecommendationButtonLabel":{"id":"discardRecommendationButtonLabel","label":"Discard recommendation button label","description":"The label of the button allowing patients to continue and discard the recommendation","type":"string","required":true}},"dataPoints":{"acceptRecommendation":{"key":"acceptRecommendation","valueType":"boolean"}},"options":{"stakeholders":{"label":"Stakeholder","mode":"single"}},"previewable":false},"redirect":{"key":"redirect","title":"Redirect","description":"Redirect the user to a website or a location within your app","category":"Workflow","fields":{"redirectUrl":{"id":"redirectUrl","label":"Redirect URL","description":"","type":"string","required":true},"redirectMessage":{"id":"redirectMessage","label":"Message","description":"A message that is briefly shown to the user when doing the redirect, leave blank to show nothing","type":"html","required":false}},"dataPoints":{},"options":{"stakeholders":{"label":"Stakeholder","mode":"single"}},"previewable":false},"returnObject":{"key":"returnObject","title":"Return object","description":"Return an object to be stored as a datapoint","category":"Workflow","fields":{"array":{"id":"array","label":"Send array instead of object","type":"boolean","required":false}},"dataPoints":{"object":{"key":"object","valueType":"json","jsonSchemaSource":{"system":"extension","key":"example"}}},"previewable":false}},"webhooks":[],"description":"Extension for experimental purposes","icon_url":"https://cdn-icons-png.flaticon.com/512/3830/3830179.png","title":"Experimental extension","category":"Workflow","author":{"authorType":"Awell"},"settings":{},"schemas":{"example":{"$schema":"http://json-schema.org/draft-06/schema#","title":"example","description":"A schema for validating a mock object with various property types","type":"object","properties":{"message":{"type":"string","description":"A greeting message"},"number":{"type":"integer","description":"A numeric value"},"array":{"type":"array","description":"An array of integers","items":{"type":"integer"}},"nested":{"type":"object","description":"A nested object with a key-value pair","properties":{"key":{"type":"string"}},"required":["key"]},"boolean":{"type":"boolean","description":"A boolean value"}},"required":["message","number","array","nested","boolean"]}}},{"key":"external-server","htmlDocs":"External Server
\nHere will be some instructions.
","changelog":"CHANGELOG
","actions":{"externalServer":{"key":"externalServer","title":"External Server","description":"An extension action used to prototype extensions on your local machine.","category":"Data","fields":{"extension":{"type":"string","id":"extension","label":"Extension Key","description":"The key of the extension you want to use","required":true},"action":{"type":"string","id":"action","label":"Action Key","description":"The key of the action you want to use","required":true},"input":{"type":"json","id":"input","label":"Input","description":"The input (in JSON format: {'fields': {key: val}, 'settings': {key: val}})"}},"dataPoints":{"data_points":{"key":"data_points","valueType":"string"}},"previewable":false},"mtls":{"key":"mtls","title":"mTLS Connect","description":"An extension action that communicates using mTLS by sending a POST request.","category":"Data","fields":{"payload":{"type":"json","id":"payload","label":"Payload","description":"Payload (in JSON format: {'fields': {key: val}, 'settings': {key: val}})"}},"dataPoints":{"response":{"key":"response","valueType":"string"}},"previewable":false}},"webhooks":[],"description":"External server used for prototyping. See README for additional documentation.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1696493305/Awell%20Extensions/imgbin-computer-icons-data-migration-extract-transform-load-others-z1r9GD10ftiy2XXyhy7kWi413.jpg","title":"External Server","category":"Data","author":{"authorType":"Awell"},"settings":{"url":{"key":"url","label":"URL","obfuscated":false,"description":"The URL you want to use in order to test your local extensions"}}},{"key":"formsort","htmlDocs":"\n
title: Formsort
\ndescription: Formsort is a fully-managed form-building platform.
\nFormsort
\nFormsort is a fully-managed form-building platform. Team can use the online studio (a specialized content management system for forms) to create form content, modify styles, and configure integrations.
\nFormsort hosts your fully-branded forms, either on one of your subdomains or embedded in a page on your site. When responders submit answers, Formsort sends the answers to a destination of your liking directly. Formsort doesn't store the responder's answers.
\nFlow settings
\nIn order for the flows to work well with Awell care flows, make sure your flow settings are set as follows:
\n- \n
- There should be no redirects \n
- \"Start each session as a new responder\" should be checked \n
- \"Enable URL navigation\" should be disabled \n
- \"Enable restart once flow completed\" should be disabled \n
- \"Enable close once flow completed\" should be disabled \n
Custom Actions
\nComplete flow
\nLet a stakeholder complete a Formsort flow from within Awell Hosted Pages.
\nLimitations:\nCurrently data from the flow is not ingested into Awell yet and cannot be used in your care flow as data points.
","changelog":"Formsort changelog
","actions":{"completeFlow":{"key":"completeFlow","title":"Complete flow","description":"Let a stakeholder complete a Formsort flow with Awell Hosted Pages.","category":"Forms","fields":{"clientLabel":{"id":"clientLabel","label":"Client label","description":"The name (id) of your client.","type":"string","required":true},"flowLabel":{"id":"flowLabel","label":"Flow label","description":"The name of your flow","type":"string","required":true},"variantLabel":{"id":"variantLabel","label":"Variant label","description":"The name of the variant.","type":"string","required":false}},"options":{"stakeholders":{"label":"Stakeholder","mode":"single"}},"previewable":false}},"webhooks":[],"description":"Formsort is a fully-managed form-building platform.","icon_url":"https://images.saasworthy.com/formsort_30763_logo_1658487172_csumf.jpg","title":"Formsort","category":"Forms","author":{"authorType":"Awell"},"settings":{"apiKey":{"key":"apiKey","label":"API key","description":"Your Formsort API key.","obfuscated":true,"required":false},"environment":{"key":"environment","label":"Environment","description":"Should be \"staging\" or \"production\". Defaults to \"production\".","obfuscated":false,"required":false}}},{"key":"freshdesk","htmlDocs":"\n
title: Freshdesk
\ndescription: Freshdesk is a cloud-based customer service software that helps businesses manage and streamline their customer support operations.
\nFreshdesk
\nFreshdesk is a cloud-based customer service software that helps businesses manage and streamline their customer support operations.
\nExtension settings
\nTo set up this extension, you will need to provide your Freshdesk helpdesk domain and API key.
","changelog":"CHANGELOG
","actions":{"getTicket":{"key":"getTicket","title":"Get ticket","description":"Get a ticket from Freshdesk.","category":"Customer Support","fields":{"ticketId":{"id":"ticketId","label":"Ticket ID","description":"The ID of the ticket to update","type":"string","required":true}},"previewable":true,"dataPoints":{"ticketData":{"key":"ticketData","valueType":"json"},"requesterId":{"key":"requesterId","valueType":"string"},"subject":{"key":"subject","valueType":"string"},"type":{"key":"type","valueType":"string"},"priorityValue":{"key":"priorityValue","valueType":"number"},"priorityLabel":{"key":"priorityLabel","valueType":"string"},"statusValue":{"key":"statusValue","valueType":"number"},"statusLabel":{"key":"statusLabel","valueType":"string"},"sourceValue":{"key":"sourceValue","valueType":"number"},"sourceLabel":{"key":"sourceLabel","valueType":"string"},"descriptionText":{"key":"descriptionText","valueType":"string"},"descriptionHtml":{"key":"descriptionHtml","valueType":"string"},"customFields":{"key":"customFields","valueType":"json"},"tags":{"key":"tags","valueType":"strings_array"}}},"updateTicket":{"key":"updateTicket","title":"Update ticket","description":"Update a ticket in Freshdesk.","category":"Customer Support","fields":{"ticketId":{"id":"ticketId","label":"Ticket ID","description":"The ID of the ticket to update","type":"string","required":true},"subject":{"id":"subject","label":"Subject","description":"Subject of the ticket","type":"string","required":false},"type":{"id":"type","label":"Type","description":"Helps categorize the ticket according to the different kinds of issues your support team deals with","type":"string","required":false},"status":{"id":"status","label":"Status","description":"The status of the ticket. Possible values: 2 (Open), 3 (Pending), 4 (Resolved), 5 (Closed)","type":"numeric","required":false,"options":{"dropdownOptions":[{"label":"Open","value":2},{"label":"Pending","value":3},{"label":"Resolved","value":4},{"label":"Closed","value":5}]}},"priority":{"id":"priority","label":"Priority","description":"The priority of the ticket. Possible values: 1 (Low), 2 (Medium), 3 (High), 4 (Urgent)","type":"numeric","required":false,"options":{"dropdownOptions":[{"label":"Low","value":1},{"label":"Medium","value":2},{"label":"High","value":3},{"label":"Urgent","value":4}]}},"description":{"id":"description","label":"Description","description":"Content of the ticket","type":"html","required":false},"customFields":{"id":"customFields","label":"Custom fields","description":"Key value pairs containing the names and values of custom fields. All values must be strings.","type":"json","required":false},"dueBy":{"id":"dueBy","label":"Due by","description":"Timestamp that denotes when the ticket is due to be resolved","type":"date","required":false},"tags":{"id":"tags","label":"Tags","description":"Comma separated list of tags to associate with the ticket.","type":"string","required":false}},"previewable":true,"dataPoints":{}},"addNoteToTicket":{"key":"addNoteToTicket","title":"Add note to ticket","description":"Add a note to a ticket in Freshdesk.","category":"Customer Support","fields":{"ticketId":{"id":"ticketId","label":"Ticket ID","description":"The ID of the ticket to update","type":"string","required":true},"body":{"id":"body","label":"Body","description":"Content of the note in HTML","type":"html","required":true},"incoming":{"id":"incoming","label":"Incoming","description":"Set to true if a particular note should appear as being created from outside (i.e., not through web portal). The default value is false","type":"boolean","required":false},"notifyEmails":{"id":"notifyEmails","label":"Notify emails","description":"Comma separated list of email addresses of agents/users who need to be notified about this note","type":"string","required":false},"private":{"id":"private","label":"Private","description":"Set to true if the note is private. The default value is true.","type":"boolean","required":false},"userId":{"id":"userId","label":"User ID","description":"ID of the agent/user who is adding the note","type":"string","required":false}},"previewable":true,"dataPoints":{}},"getContact":{"key":"getContact","title":"Get contact","description":"Get a contact from Freshdesk.","category":"Customer Support","fields":{"contactId":{"id":"contactId","label":"Contact ID","description":"The ID of the contact to get. This is commonly also referred to as the requester ID, particularly in the context of support tickets.","type":"string","required":true}},"previewable":true,"dataPoints":{"contactData":{"key":"contactData","valueType":"json"},"name":{"key":"name","valueType":"string"},"email":{"key":"email","valueType":"string"},"customFields":{"key":"customFields","valueType":"json"},"tags":{"key":"tags","valueType":"strings_array"}}}},"webhooks":[{"key":"ticketCreated","dataPoints":{"ticketId":{"key":"ticketId","valueType":"string"}}}],"description":"Freshdesk is a cloud-based customer service software that helps businesses manage and streamline their customer support operations.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1751905938/Awell%20Extensions/png-clipart-freshdesk-logo-icon-tech-companies.png","title":"Freshdesk","category":"Customer Support","author":{"authorType":"Awell"},"settings":{"domain":{"key":"domain","label":"Freshdesk helpdesk domain","description":"Will be used to construct the API URL. E.g. https://\n
title: Freshsales
\ndescription: Freshsales is a cloud-based, AI-powered customer relationship management (CRM) software designed to help sales teams organize, manage, and close deals more efficiently.
\nFreshsales
\nFreshsales is a cloud-based, AI-powered customer relationship management (CRM) software designed to help sales teams organize, manage, and close deals more efficiently.
\nExtension settings
\nTo set up this extension, you will need to provide your Freshsales CRM domain and API key.
","changelog":"CHANGELOG
","actions":{"getLead":{"key":"getLead","title":"Get lead","description":"Get a lead from Freshsales.","category":"Customer Support","fields":{"leadId":{"id":"leadId","label":"Lead ID","description":"The ID of the lead to get","type":"string","required":true}},"previewable":true,"dataPoints":{"leadData":{"key":"leadData","valueType":"json"},"email":{"key":"email","valueType":"string"},"mobileNumber":{"key":"mobileNumber","valueType":"telephone"},"address":{"key":"address","valueType":"string"},"city":{"key":"city","valueType":"string"},"state":{"key":"state","valueType":"string"},"zipcode":{"key":"zipcode","valueType":"string"},"country":{"key":"country","valueType":"string"},"timeZone":{"key":"timeZone","valueType":"string"},"displayName":{"key":"displayName","valueType":"string"},"firstName":{"key":"firstName","valueType":"string"},"lastName":{"key":"lastName","valueType":"string"}}},"searchLeadByEmail":{"key":"searchLeadByEmail","title":"Search lead by email","description":"Search a lead by email from Freshsales.","category":"Customer Support","fields":{"email":{"id":"email","label":"Email","description":"The email of the lead to search for","type":"string","required":true}},"previewable":true,"dataPoints":{"leadData":{"key":"leadData","valueType":"json"},"email":{"key":"email","valueType":"string"},"mobileNumber":{"key":"mobileNumber","valueType":"telephone"},"city":{"key":"city","valueType":"string"},"country":{"key":"country","valueType":"string"},"displayName":{"key":"displayName","valueType":"string"},"firstName":{"key":"firstName","valueType":"string"},"lastName":{"key":"lastName","valueType":"string"}}},"searchContactByEmail":{"key":"searchContactByEmail","title":"Search contact by email","description":"Search a contact by email from Freshsales.","category":"Customer Support","fields":{"email":{"id":"email","label":"Email","description":"The email of the lead to search for","type":"string","required":true}},"previewable":true,"dataPoints":{"contactData":{"key":"contactData","valueType":"json"},"email":{"key":"email","valueType":"string"},"mobileNumber":{"key":"mobileNumber","valueType":"telephone"},"city":{"key":"city","valueType":"string"},"country":{"key":"country","valueType":"string"},"displayName":{"key":"displayName","valueType":"string"},"firstName":{"key":"firstName","valueType":"string"},"lastName":{"key":"lastName","valueType":"string"}}}},"webhooks":[],"description":"Freshsales is a cloud-based, AI-powered customer relationship management (CRM) software designed to help sales teams organize, manage, and close deals more efficiently.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1751917615/Awell%20Extensions/freshsales.png","title":"Freshsales","category":"Customer Support","author":{"authorType":"Awell"},"settings":{"domain":{"key":"domain","label":"Freshsales domain","description":"Will be used to construct the API URL. E.g. https://\n
title: Gridspace
\ndescription: Gridspace
\nWhat is Gridspace
\nGridspace is a conversational speech bot platform using its proprietary AI, Grace. It was built for long-form conversations over the phone, which distinguishes her from other voice AIs such as Siri and Alexa.
\nGrace can perform an an ever-increasing variety of service-oriented tasks across multiple roles. Grace's job functions include, but are by no means limited to:
\n- \n
- Healthcare Scheduler \n
- Lead Qualifier \n
- Payments Facilitator \n
- After-hours Phone Operator \n
- Service Appointment Booker \n
Grace has the ability to manage customer service and patient care interactions independently from start to finish, or she can work in collaboration with human agents.
","changelog":"Gridspace changelog
\nOctober, 2024
\nCreated Gridspace extension
","actions":{"callWithGrace":{"key":"callWithGrace","title":"Call with Grace","description":"Use AI phone conversations to communicate with your patients.","category":"Communication","fields":{"flowId":{"id":"flowId","label":"Flow ID","type":"string","required":true,"description":"The ID of the flow to use for the call."},"phoneNumber":{"id":"phoneNumber","label":"Phone Number","type":"string","stringType":"phone","required":true,"description":"The phone number to call."},"data":{"id":"data","label":"Data","type":"json","required":true,"description":"Any additional data to be passed to the call."}},"dataPoints":{},"previewable":false},"uploadContactToCampaign":{"key":"uploadContactToCampaign","title":"Upload Contact to Campaign","description":"Add a contact to a Gridspace autodialer campaign.","category":"Communication","fields":{"campaignId":{"id":"campaignId","label":"Campaign ID","type":"string","required":true,"description":"The ID of the Gridspace autodialer campaign."},"phoneNumber":{"id":"phoneNumber","label":"Phone Number","type":"string","stringType":"phone","required":true,"description":"The phone number to call."},"serviceTermsReviewed":{"id":"serviceTermsReviewed","label":"Service Terms Reviewed","type":"boolean","required":false,"description":"Affirmation that the Terms of Service for contacts made via Autodialer campaigns have been reviewed. Defaults to true."},"data":{"id":"data","label":"Data","type":"json","required":true,"description":"Any additional data to be passed to the campaign. Should be a JSON object."}},"dataPoints":{"data":{"key":"data","valueType":"json"},"num_uploaded_contacts":{"key":"num_uploaded_contacts","valueType":"number"}},"previewable":false}},"webhooks":[],"description":"Use AI phone conversations to communicate with your patients.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1727996065/gridspace_inc_logo_yd4j7n.jpg","category":"Communication","title":"Gridspace","author":{"authorType":"Awell"},"settings":{"accountId":{"label":"Account ID","key":"accountId","obfuscated":false,"required":true,"description":"Your Gridspace account ID."},"clientSecret":{"label":"Client Secret","key":"clientSecret","obfuscated":true,"required":true,"description":"Your Gridspace client secret."}}},{"key":"healthie","htmlDocs":"\n
title: Healthie
\ndescription: Healthie offers infrastructure for next generation digital health organizations that provide virtual-first care.
\nWhat is Healthie?
\nHealthie offers infrastructure for next generation digital health organizations that provide virtual-first care. Healthie’s API-first and fully brandable suite of solutions (Scheduling, EMR, Client Engagement) enables healthcare builders to launch and scale best-in-class experiences for their members. Healthie also offers a built-in marketplace of business and clinical integrations used by our organizations.
\nTo learn more, visit www.gethealthie.com.
\nHealthie x Awell
\nWith this extension, organizations are able to build clinical workflows in Awell’s low-code platform and easily integrate them into Healthie. By doing so, Healthie’s customers can automate routine clinical tasks, synchronize data between systems and drive seamless coordination between care team and patients.
\nBy combining Healthie’s web and mobile platform with our clinical workflows, clinicians will be able to provide the right care, at the right time for the right patient.
\nExtension settings
\nIn order to set up this extension, you will need to provide a Healthie API key and Api url. You can obtain an API key via the Healthie portal (Settings > Developer > API keys). You can obtain API url in the DOCUMENTATION in Environments section.
Please note that the extension automatically prefixes the API key with Basic so please provide your raw API key without Basic in front.
Custom Actions
\nSend chat message action
\nSends a chat message to a patient in name of the provided provider ID. Will create a new conversation if no active conversation between patient and provider exists or sends a message in an existing conversation if there is an active conversation between the two.
\nCreate patient
\nCreates a new patient according to the passed fields. After completion the healthiePatientId will be exposed as a data point in the care flow.
Update patient
\nUpdates a specific patient (defined by the provided id) according to the passed fields.
Apply tag to patient
\nAdds a tag (existing one, identified by an id) to a patient. Although the Healthie API call allows assigning multiple tags per API call, for simplicity of the logic this action can only take one tag as input. Assigning multiple tags is possible by adding multiple actions.
Remove tag from patient
\nRemoves a tag (identified by an id) from a patient.
Create charting note
\nCreates a charting note with the provided note_content.
Prerequisites and set-up:
\n- \n
- The form specified by the
form_idexists in Healthie. \n - The form specified by the
form_idis a charting form (click \"Convert to charting form\" in the form options). \n - The form contains at least one question of type
textarea(long text answer). The action will write the content of the charting note in the first question of that type it finds in the form. \n
Send form completion request
\nSend a form completion request to the patient. You will need the Healthie patient ID and the ID of the form you would like the patient to complete.
\nAlthough the Healthie API call allows sending form completion requests to multiple users per API call (see recipient_ids in their docs), we decided that every action only sends one form completion request. This heavily simplifies the logic and better fits our domain model (1-to-1 relationship between patient and pathway). If a user would like to send multiple form completion requests, they you can just add multiple actions.
\nArchive patient
\nArchives a patient with a given id.
Create location
\nCreates a location. ID of the created location is stored as locationId data point.
Close chat conversation
\nCloses chat conversation with a given id as a provider with the given provider_id.
Delete appointment
\nDeletes an appointment with a given id.
Cancel appointment
\nCancels an appointment with a given id.
Get metric entry
\nRetrieve the most recent metric entry from a given category.
Create metric entry
\nCreate a metric entry for a patient in Healthie. The category of the metric is the literal name of the metric in Healthie. So if you have a metric in Healthie called \"Weight\", you should use \"Weight\" as the category.
\nCheck patient tag
\nChecks that a patient has an active tag with given id
Check scheduled appointments
\nChecks that a patient has active scheduled appointment with given appointmentTypeId
Get form answers
\nThis action will retrieve the form answers for a answer group with a given ID. The complete form answers object will be stored as JSON and will be available in Awell Studio as a data point
\nExample of a form answers response:
\n[\n {\n \"id\": \"640\",\n \"label\": \"Please enter some information about the person who referred you.\",\n \"answer\": \"\"\n },\n {\n \"id\": \"641\",\n \"label\": \"Name\",\n \"answer\": \"Chris\"\n }\n]\nDerrived data points can be used to then store the answer of a specific question in a data point. You can use the following JSONPath expression to retrieve the answer for a given question ID: $[?(@.id == '<ID>')].answer
Healthie changelog
\nJanuary 2024
\n- \n
- Add \"Check patient tag\" action \n
- Add \"Check scheduled appointments\" action \n
October 2023
\n- \n
- Add \"Update patient quick notes\" action \n
- Add \"Create metric entry\" action. \n
September 5, 2023
\n- \n
- add Healthie gender to Sex in iso format mapper in
getPatient\n
May 2023
\n- \n
- New webhooks added:
appliedTagCreated,appliedTagDeleted,appointmentDeleted,appointmentUpdated,formAnswerGroupCreated,formAnswerGroupDeleted,formAnswerGroupLocked,formAnswerGroupSigned,labOrderCreated,labOrderUpdated,messageCreated,messageDeleted,metricEntryCreated,metricEntryDeleted,metricEntryUpdated,patientUpdated,requestFormCompletionCreated,requestFormCompletionDeleted,requestFormCompletionUpdated,taskCreated,taskDeleted,taskUpdated\n
April 2023
\n- \n
- Create task action: now also adds support for reminders. \n
\n
title: Hello world
\ndescription: This is an example extension.
\nHello world extension
","changelog":"Hello world changelog
","actions":{"log":{"key":"log","title":"Log hello world","description":"This is a dummy Custom Action for extension developers.","category":"Demo","fields":{"hello":{"id":"hello","label":"Hello","description":"A string field configured at design time","type":"string"},"secondField":{"id":"secondField","label":"Second Field","description":"A second field","required":false,"type":"string"},"thirdField":{"id":"thirdField","label":"Third Field","description":"A third field","required":false,"type":"numeric"}},"previewable":false,"dataPoints":{"world":{"key":"world","valueType":"string"},"clear":{"key":"clear","valueType":"string"},"secret":{"key":"secret","valueType":"string"}}},"logTwo":{"key":"log-two","title":"Log a second time","description":"This is a dummy Custom Action for extension developers.","category":"Demo","fields":{"hello":{"id":"hello","label":"Hello","description":"A string field configured at design time","type":"string"}},"previewable":false,"dataPoints":{"world":{"key":"world","valueType":"string"}}},"frontend":{"key":"frontend","title":"Frontend","description":"This is a dummy Custom Action for extension developers.","category":"Forms","fields":{"hello":{"id":"hello","label":"Hello","description":"A string field configured at design time","type":"string"}},"previewable":false,"options":{"stakeholders":{"label":"Stakeholder","mode":"single"}},"dataPoints":{"world":{"key":"world","valueType":"string"}}},"failoWorld":{"key":"test-retry","title":"Fail-o World","description":"A test action that fails for a specified number of attempts to test the automated retry mechanism.","category":"Demo","fields":{"failureAttempts":{"id":"failureAttempts","label":"Number of attempts that should fail","description":"Specify how many attempts should fail before the action succeeds","type":"numeric","required":true}},"previewable":false,"supports_automated_retries":true,"dataPoints":{"currentAttempt":{"key":"currentAttempt","valueType":"number"},"result":{"key":"result","valueType":"string"}}}},"webhooks":[{"key":"demo","dataPoints":{"eventType":{"key":"eventType","valueType":"string"},"hello":{"key":"webhookDataPoint","valueType":"string"},"a_string":{"key":"a_string","valueType":"string"},"a_number":{"key":"a_number","valueType":"number"},"a_boolean":{"key":"a_boolean","valueType":"boolean"},"a_date":{"key":"a_date","valueType":"date"},"a_phone":{"key":"a_phone","valueType":"telephone"},"a_json":{"key":"a_json","valueType":"json"}}}],"description":"An example extension developers can look at to get started with building their first extension.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1678870116/Awell%20Extensions/Awell_Logo.png","title":"Hello World !","category":"Demo","author":{"authorType":"Awell"},"settings":{"clear":{"key":"clear","label":"Clear text","obfuscated":false,"description":"A clear text value needed by the extension like an API endpoint."},"secret":{"key":"secret","label":"Secret","obfuscated":true,"description":"A secret value needed by the extension like an API key."}}},{"key":"hubspot","htmlDocs":"\n
title: Hubspot
\ndescription: HubSpot is a customer relationship management (CRM) platform that provides a suite of tools for marketing, sales, customer service, and content management.
\nHubspot
\nHubSpot is a customer relationship management (CRM) platform that offers a comprehensive suite of tools for marketing, sales, customer service, and content management. It is widely recognized for its user-friendly interface and inbound marketing methodology, which focuses on attracting customers through valuable content and experiences instead of traditional advertising.
\nHubSpot provides features like email marketing, social media management, lead generation, analytics, and automation to help businesses attract, engage, and delight customers.
\nSettings and Setup
\nTo use the HubSpot extension, you need an access token to authenticate with the HubSpot API. We recommend creating a private app in your HubSpot account for Awell and using the provided access token. You should only provide the minimum scopes necessary for the actions you intend to use. The required scopes for each action are listed in the documentation below.
\nSMTP Authentication
\nIf you plan to use the \"Send email with SMTP\" action, you will need to provide your username and password to authenticate requests to HubSpot's SMTP server.
\nAdd-ons
\nSending transactional emails via HubSpot requires you to add the corresponding add-ons to your HubSpot account.
\nActions
\nCreate or update contact
\nCreates or updates a contact in HubSpot using the provided information. The patient is matched based on their email address—if a match is found, the existing contact is updated (PATCH); otherwise, a new contact is created.
\nScope: crm.objects.contacts.write
Get contact
\nRetrieve the details of a contact based on the provided contact ID.
\nScope: crm.objects.contacts.read
Send email with SMTP
\nSend an email using HubSpot's SMTP server.
\nSending emails via SMTP has some limitations. The most significant drawback is that you cannot use templates or apply styling when sending emails through SMTP. SMTP is generally more manual and less integrated with HubSpot's smart content and template features.
\nScope: N/A
\nSend email with Single Send API
\nThe Single Send API is the recommended method for sending transactional emails with HubSpot. You can create email templates in your HubSpot account and use this action to send emails to recipients. This method allows you to take advantage of features like smart content and personalization.
\nScope: transactional-email
Hubspot changelog
","actions":{"createOrUpdateContact":{"key":"createOrUpdateContact","title":"Create or update contact","description":"Create or update a contact in HubSpot","category":"Customer Support","fields":{"email":{"id":"email","label":"Email","description":"The email of the contact","type":"string","required":true},"firstName":{"id":"firstName","label":"First name","description":"The first name of the contact","type":"string","required":false},"lastName":{"id":"lastName","label":"Last name","description":"The last name of the contact","type":"string","required":false},"phone":{"id":"phone","label":"Phone","description":"The phone number of the contact","type":"string","stringType":"phone","required":false},"customProperties":{"id":"customProperties","label":"Custom properties","description":"An object of key-values pairs of custom properties of the contact","type":"json","required":false}},"previewable":true,"dataPoints":{"hubspotContactId":{"key":"hubspotContactId","valueType":"string"},"contactResource":{"key":"contactResource","valueType":"json"}}},"getcontact":{"key":"getcontact","title":"Get contact","description":"Retrieve the contact details from HubSpot","category":"Customer Support","fields":{"contactId":{"id":"contactId","label":"Contact ID","description":"","type":"string","required":true}},"previewable":true,"dataPoints":{"firstName":{"key":"firstName","valueType":"string"},"lastName":{"key":"lastName","valueType":"string"},"email":{"key":"email","valueType":"string"}}},"sendEmailWithSmtp":{"key":"sendEmailWithSmtp","title":"Send email (SMTP)","description":"Send email with SMTP","category":"Customer Support","fields":{"from":{"id":"from","label":"From","description":"","type":"string","required":true},"to":{"id":"to","label":"To","description":"","type":"string","required":true},"subject":{"id":"subject","label":"Subject","description":"","type":"string","required":true},"message":{"id":"message","label":"Message","description":"","type":"html","required":true}},"previewable":true,"dataPoints":{}},"sendEmailWithSingleSendApi":{"key":"sendEmailWithSingleSendApi","title":"Send email (Single Send API)","description":"Send email with the Single Send API","category":"Customer Support","fields":{"emailId":{"id":"emailId","label":"Email ID","description":"The ID of the email (template)","type":"string","required":true},"from":{"id":"from","label":"From","description":"","type":"string","required":true},"to":{"id":"to","label":"To","description":"","type":"string","required":true},"contactProperties":{"id":"contactProperties","label":"Contact properties","description":"A JSON map of contact property values. Each property will be set on the contact record.","type":"json","required":false},"customProperties":{"id":"customProperties","label":"Custom properties","description":"A JSON map of key-value properties that will be rendered in the template.","type":"json","required":false}},"previewable":true,"dataPoints":{"statusId":{"key":"statusId","valueType":"string"}}}},"webhooks":[],"description":"HubSpot is a customer relationship management (CRM) platform that provides a suite of tools for marketing, sales, customer service, and content management.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1726325417/Awell%20Extensions/168_Hubspot_logo_logos-512.webp","title":"HubSpot","category":"Customer Support","author":{"authorType":"Awell"},"settings":{"accessToken":{"key":"accessToken","label":"Access token","obfuscated":true,"required":true,"description":"The access token will be used to authenticate requests to the HubSpot API"},"smtpUsername":{"key":"smtpUsername","label":"SMTP Username","obfuscated":false,"required":false,"description":"Only required if you wish to send emails via the HubSpot SMTP API"},"smtpPassword":{"key":"smtpPassword","label":"SMTP Password","obfuscated":true,"required":false,"description":"Only required if you wish to send emails via the HubSpot SMTP API"}}},{"key":"identityVerification","htmlDocs":"\n
title: Identity verification
\ndescription: Verify the identity of the patient by asking their date of birth
\nIdentity verification
\nVerify the patient's identity by asking for a piece of personal information, such as their date of birth. If the information provided by the user does not match the details stored in the patient's profile, the user will not be allowed to proceed to the activity inside the Hosted Pages app.
","changelog":"Identity verification changelog
","actions":{"dobCheck":{"key":"dobCheck","title":"DOB verification","description":"The user will be prompted to enter a dob which will be checked against the dob stored in the patient profile","category":"Workflow","fields":{"label":{"id":"label","label":"Label","description":"Label shown to the user above the date input","type":"string","required":false}},"previewable":false,"dataPoints":{"success":{"key":"success","valueType":"boolean"}},"options":{"stakeholders":{"label":"Stakeholder","mode":"single"}}}},"webhooks":[],"description":"Verify the patient's identity by asking for a piece of personal information, such as their date of birth. ","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1725995141/Awell%20Extensions/120965-200.png","title":"Identity Verification","category":"Customer Support","author":{"authorType":"Awell"},"settings":{}},{"key":"infobip","htmlDocs":"\n
title: Infobip
\ndescription: Infobip is a global cloud communications platform that provides a wide range of communication and customer engagement solutions for businesses.
\nInfobip
\nInfobip is a global cloud communications platform that provides a wide range of communication and customer engagement solutions for businesses. The company offers a suite of services and tools designed to help organizations connect with their customers, clients, and partners through various communication channels, including SMS, email, voice, chat apps, and more.
\nExtension settings
\nIn order to set up this extension, you will minimally need to provide:
\n\nWhen utilizing the Infobip extension for sending emails and text messages, you'll need a 'from email' address and a 'from phone number' respectively.
\nActions
\nSend SMS
\nSend a text message to a recipient.
\nSend email
\nSends a simple email to a recipient.
\nSend email with template
\nSend an email, using a template, to a recipient. You need to create a Broadcast email template as that is the only type of template supported by Infobip's API. Templates can be created and managed via the Infobip web portal.
\nWhen using this action, the from/sender details and subject as specified in the template will be used. However, you can specify a subject if you would like to overwrite the subject specified in the template.
\nWithin your template, you can harness placeholders using Infobip's {{ syntax. This feature allows you to craft templates with both static and dynamic content. You can determine the dynamic content's value when configuring the action in Awell Studio. For instance, if your template includes two placeholders, {{variable_1}} and {{variable_2}}, you can provide the following data in the placeholders action field to set values for these placeholders:
{\n \"variable_1\": \"Hello\",\n \"variable_2\": \"World\"\n}\nInfobip changelog
","actions":{"sendSms":{"key":"sendSms","title":"Send SMS","description":"Sends SMS using Infobip","category":"Communication","fields":{"from":{"label":"From","id":"from","type":"string","stringType":"phone","required":false,"description":"The phone number you wish to use for sending the text message. Defaults to value provided in settings."},"to":{"label":"To","id":"to","type":"string","stringType":"phone","required":true,"description":"The phone number to which you intend to send the text message"},"text":{"id":"text","label":"Content","type":"text","required":true,"description":"The content of the message being sent"}},"previewable":true},"sendEmail":{"key":"sendEmail","title":"Send email","description":"Sends email using Infobip","category":"Communication","fields":{"from":{"label":"From","id":"from","type":"string","required":false,"description":"The email address you wish to use for sending emails. Defaults to value provided in settings."},"to":{"label":"To","id":"to","type":"string","required":true,"description":"The email address to which you intend to send the email"},"subject":{"label":"Subject","id":"subject","type":"string","required":true,"description":""},"content":{"label":"Content","id":"content","type":"html","required":true,"description":""}},"previewable":true},"sendEmailWithTemplate":{"key":"sendEmailWithTemplate","title":"Send email with template","description":"Sends email with a template using Infobip","category":"Communication","fields":{"to":{"label":"To","id":"to","type":"string","required":true,"description":"The email address to which you intend to send the email"},"subject":{"label":"Subject","id":"subject","type":"string","required":false,"description":"When provided, it overwrites the subject specified in the Broadcast template"},"templateId":{"label":"Template ID","id":"templateId","type":"numeric","required":true,"description":"The ID of the template used for generating email content"},"placeholders":{"label":"Placeholders","id":"placeholders","type":"json","required":true,"description":"The values for the placeholders defined in your template. Must be a valid key-value pair JSON object."}},"previewable":true}},"webhooks":[],"description":"Infobip is a global cloud communications platform that provides a wide range of communication and customer engagement solutions for businesses.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1697459181/Awell%20Extensions/download_3.png","title":"Infobip","category":"Communication","author":{"authorType":"Awell"},"settings":{"baseUrl":{"label":"Base URL","key":"baseUrl","obfuscated":false,"required":true,"description":"Your unique API base URL"},"apiKey":{"label":"API key","key":"apiKey","obfuscated":true,"required":true,"description":"Your Infobip API key"},"fromPhoneNumber":{"label":"From phone number","key":"fromPhoneNumber","obfuscated":false,"required":true,"description":"The phone number you wish to use for sending text messages, must be in E.164 format (eg. +19033428784)"},"fromEmail":{"label":"From email","key":"fromEmail","obfuscated":false,"required":true,"description":"The email address you wish to use for sending text messages. When you are using Broadcast templates, the from email defined in the template will be used."}}},{"key":"iterable","htmlDocs":"\n
title: Iterable
\ndescription: Iterable is an email marketing automation platform that allows creating, sending, and tracking personalized email campaigns.
\nIterable
\nIterable is a marketing automation platform that provides tools and services for businesses to engage with their customers through email, SMS, in-app notifications, and other digital channels. It allows businesses to create and manage personalized marketing campaigns, track customer behavior, and analyze data to optimize their marketing strategies.
\nIterable offers features such as email marketing, segmentation, A/B testing, workflow automation, and analytics to help businesses deliver the right message to the right audience at the right time.
\nExtension settings
\nIn order to set up this extension, you will need an API key to authenticate with the Iterable API.
\nCustom Actions
\nSend email
\nSend an email to a specific email address.
\nImportant: Provide a recipientEmail or a recipientUserId (but not both), depending on how your project identifies users.
Track Event
\nTrack an event in Iterable.
\nImportant: Provide an email or a userId (but not both), depending on how your project identifies users.
Iterable changelog
","actions":{"sendEmail":{"key":"sendEmail","title":"Send email","description":"Send an email to a specific email address.","category":"Communication","fields":{"campaignId":{"label":"Campaign ID","id":"campaignId","type":"numeric","required":true,"description":""},"recipientEmail":{"label":"Recipient email","id":"recipientEmail","type":"string","required":false,"description":"An email address that identifies a user profile in Iterable. Provide a recipient email or a recipient user ID, but not both, depending on how your project identifies users."},"recipientUserId":{"label":"Recipient user ID","id":"recipientUserId","type":"string","required":false,"description":"A user ID that identifies a user profile in Iterable. Provide a recipient email or a recipient user ID, but not both, depending on how your project identifies users."},"dataFields":{"label":"Data fields","id":"dataFields","type":"json","required":false,"description":"Fields to merge into email template."},"allowRepeatMarketingSends":{"label":"Allow repeat marketing sends?","id":"allowRepeatMarketingSends","type":"boolean","required":false,"description":"Defaults to true."},"metadata":{"label":"Metadata","id":"metadata","type":"json","required":false,"description":"Metadata to pass back via webhooks. Not used for rendering."}},"previewable":true},"trackEvent":{"key":"trackEvent","title":"Track event","description":"Track an event in Iterable","category":"Communication","fields":{"email":{"id":"email","label":"Email","type":"string","required":false,"description":"An email address that identifies a user profile in Iterable. Provide a recipient email or a recipient user ID, but not both, depending on how your project identifies users."},"userId":{"id":"userId","label":"User ID","type":"string","required":false,"description":"A user ID that identifies a user profile in Iterable. Provide a recipient email or a recipient user ID, but not both, depending on how your project identifies users."},"eventName":{"id":"eventName","label":"Event name","type":"string","required":true,"description":""},"dataFields":{"label":"Data fields","id":"dataFields","type":"json","required":false,"description":"Additional data associated with event"}},"previewable":true}},"webhooks":[],"description":"Iterable is an email marketing automation platform that allows creating, sending, and tracking personalized email campaigns.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1696933028/Awell%20Extensions/logo_1668536435066.jpg","title":"Iterable","category":"Communication","author":{"authorType":"Awell"},"settings":{"apiKey":{"label":"API key","key":"apiKey","obfuscated":true,"required":true,"description":"API key used to authenticate with the Iterable API"}}},{"key":"landingAi","htmlDocs":"\n
title: Landing.ai
\ndescription: Turn your documents and images into visual intelligence. LandingAI’s cutting-edge software platform makes computer vision easy for a wide range of applications across all industries.
\nLanding.ai
\nTurn your documents and images into visual intelligence. LandingAI’s cutting-edge software platform makes computer vision easy for a wide range of applications across all industries.
\nExtension settings
\nTo enable the extension, you must configure an API key. You can obtain this key from the Landing.ai platform.
\nActions
\nDocument extraction
\nExtract structured data from an image or PDF by providing a URL to the file. Please note that the file has to be publicly accessible. If you require enhanced security, we can also build custom connectors to access secure data stores such as Google Cloud Storage (GCS), AWS, and others. Please contact our customer support team to explore this option.
\nIn most cases, you'll want to specify the \"Fields schema\", which allows you to define what data to extract and the desired output format. This schema must be written in JSON following a specific format.
\nWe recommend creating the schema using Landing.ai’s playground, exporting it, and then copying it into Awell.
\nExample schema:
\n{\n \"type\": \"object\",\n \"title\": \"Physician Referral Extraction Schema\",\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"required\": [\n \"date_of_birth\",\n \"urgency\",\n \"Referral reason\"\n ],\n \"properties\": {\n \"date_of_birth\": {\n \"type\": \"string\",\n \"format\": \"YYYY-MM-DD\",\n \"description\": \"Date of birth of the patient\"\n },\n \"urgency\": {\n \"type\": \"string\",\n \"description\": \"Urgency of the referral\"\n },\n \"Referral reason\": {\n \"type\": \"string\",\n \"description\": \"Reason of the referral\"\n }\n },\n \"description\": \"Schema for extracting high-value, form-like fields from a physician's referral markdown document.\"\n}\nCHANGELOG
","actions":{"documentExtraction":{"key":"documentExtraction","title":"Document extraction","description":"Extract structured data from documents and images","category":"Document Management","fields":{"fileType":{"id":"fileType","label":"File type","description":"The type of file to extract data from","type":"string","options":{"dropdownOptions":[{"label":"Image","value":"image"},{"label":"PDF","value":"pdf"}]},"required":true},"fileUrl":{"id":"fileUrl","label":"File URL","description":"The URL of the file to extract data from","type":"string","required":true},"fieldsSchema":{"id":"fieldsSchema","label":"Fields schema","description":"Defines the structure of the fields to extract from the document. Providing a schema is optional but strongly recommended, as it significantly improves the accuracy of the extracted data.","type":"json","required":false}},"previewable":true,"dataPoints":{"markdown":{"key":"markdown","valueType":"string"},"chunks":{"key":"chunks","valueType":"json"},"extractedDataBasedOnSchema":{"key":"extractedDataBasedOnSchema","valueType":"json"},"extractedMetadata":{"key":"extractedMetadata","valueType":"json"}}}},"webhooks":[],"description":"Turn your documents and images into visual intelligence. LandingAI’s cutting-edge software platform makes computer vision easy for a wide range of applications across all industries.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1752834756/Awell%20Extensions/34525670.png","title":"Landing.ai","category":"Document Management","author":{"authorType":"Awell"},"settings":{"apiKey":{"key":"apiKey","label":"API key","description":"","required":true,"obfuscated":true}}},{"key":"mailchimp","htmlDocs":"\n
title: Mailchimp
\ndescription: Mailchimp is an all-in-one marketing platform that helps businesses of all sizes to design, send, and manage email campaigns, automate marketing tasks, and build customer relationships.
\nMailchimp
\nMailchimp is an all-in-one marketing platform that helps businesses of all sizes to design, send, and manage email campaigns, automate marketing tasks, and build customer relationships.
\nIt offers a user-friendly interface that allows users to create custom email templates, segment their audience, and track their email campaign's performance with real-time analytics.
\nExtension settings
\nIn order to set up this extension, you will need to provide a:
\n- \n
- API key \n
- From name \n
- From email \n
Custom Actions
\nSend email
\nAllows for sending a plain email to a recipient.
\nSend email with a template
\nAllows for sending an email based on a template to a recipient. You can also insert variables so they are rendered in your template.
","changelog":"Mailchimp changelog
","actions":{"sendEmail":{"key":"sendEmail","title":"Send email","description":"Send an email.","category":"Communication","fields":{"to":{"id":"to","label":"To","description":"The email address of the recipient.","type":"string","required":true},"subject":{"id":"subject","label":"Subject","description":"The subject of your email.","type":"string","required":true},"body":{"id":"body","label":"Body","description":"The content of your message.","type":"html","required":true}},"previewable":false},"sendEmailWithTemplate":{"key":"sendEmailWithTemplate","title":"Send email with template","description":"Send an email based on a template to a recipient of your choice.","category":"Communication","fields":{"to":{"id":"to","label":"To","description":"The email address of the recipient.","type":"string","required":true},"templateName":{"id":"templateName","label":"Template name","description":"The immutable name or slug of a template that exists in your account.","type":"string","required":true},"subject":{"id":"subject","label":"Subject","description":"The subject of your email.","type":"string","required":true},"templateContent":{"id":"templateContent","label":"Template content","description":"An array of template content to send. Each item in the array should be a struct with two keys - name: the name of the content block to set the content for, and content: the actual content to put into the block","type":"json","required":false}},"previewable":false}},"webhooks":[],"description":"Mailchimp is an all-in-one marketing platform that helps businesses to design, send, and manage email campaigns.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1681285075/Awell%20Extensions/Mailchimp-Logo.png","title":"Mailchimp","category":"Communication","author":{"authorType":"Awell"},"settings":{"apiKey":{"key":"apiKey","label":"API Key","obfuscated":true,"required":true,"description":"Your Mailchimp API Key so the extension can authenticate with the Mailchimp API."},"fromName":{"key":"fromName","label":"From name","obfuscated":false,"required":true,"description":"The name that will be used for the \"From\" header."},"fromEmail":{"key":"fromEmail","label":"From email","obfuscated":false,"required":true,"description":"The email address that will be used for the \"From\" header."}}},{"key":"mailgun","htmlDocs":"\n
title: Mailgun
\ndescription: Mailgun is a cloud-based email delivery service that allows businesses and developers to send, receive, and track email messages.
\nMailgun
\nMailgun is a cloud-based email delivery service that allows businesses and developers to send, receive, and track email messages. It provides a powerful set of APIs that enable users to integrate email into their applications, automate email delivery, and improve deliverability rates.
\nWith Mailgun, users can send transactional emails as well as marketing emails, newsletters, and other types of bulk email. The platform also offers real-time email analytics and tools to manage unsubscribes and bounces. Overall, Mailgun provides a reliable and scalable solution for businesses and developers to handle their email needs.
\nExtension settings
\nIn order to set up this extension, you will need to provide a:
\n- \n
- Mailgun API key \n
- Mailgun domain \n
- From name \n
- From email \n
Custom Actions
\nSend email
\nAllows for sending a plain email to a recipient.
\nSend email with a template
\nAllows for sending an email based on a template to a recipient. You can also insert variables so they are rendered in your template.
","changelog":"Mailgun changelog
","actions":{"sendEmail":{"key":"sendEmail","title":"Send email","description":"Send an email to a recipient of your choice.","category":"Communication","fields":{"to":{"id":"to","label":"To","description":"The email address of the recipient.","type":"string","required":true},"subject":{"id":"subject","label":"Subject","description":"The subject of your email.","type":"string","required":true},"body":{"id":"body","label":"Body","description":"The content of your message.","type":"html","required":true}},"previewable":false},"sendEmailWithTemplate":{"key":"sendEmailWithTemplate","title":"Send email with template","description":"Send an email based on a template.","category":"Communication","fields":{"to":{"id":"to","label":"To","description":"The email address of the recipient.","type":"string","required":true},"template":{"id":"template","label":"Template","description":"The name of the template you created in the Mailgun web portal.","type":"string","required":true},"subject":{"id":"subject","label":"Subject","description":"The subject of your email.","type":"string","required":true},"variables":{"id":"variables","label":"Variables","description":"Pass values for variables you defined in your template.","type":"json","required":false}},"previewable":true}},"webhooks":[],"description":"Mailgun is a cloud-based email service provider that allows for sending transactional emails.","icon_url":"https://cdn.freebiesupply.com/logos/large/2x/mailgun-logo-png-transparent.png","title":"Mailgun","category":"Communication","author":{"authorType":"Awell"},"settings":{"apiKey":{"key":"apiKey","label":"API Key","obfuscated":true,"required":true,"description":"Your Mailgun API Key so the extension can authenticate with the Mailgun API."},"domain":{"key":"domain","label":"Domain","obfuscated":false,"required":true,"description":"The domain used to send the emails from."},"fromName":{"key":"fromName","label":"From name","obfuscated":false,"required":true,"description":"The name that will be used for the \"From\" header."},"fromEmail":{"key":"fromEmail","label":"From email","obfuscated":false,"required":true,"description":"The email address that will be used for the \"From\" header."},"region":{"key":"region","label":"Region","obfuscated":false,"required":false,"description":"Sending domains can be provisioned in different regions. Pass \"EU\" for Europe or \"US\" for United States. Defaults to \"US\"."},"testMode":{"key":"testMode","label":"Test mode","obfuscated":false,"required":false,"description":"Set to \"Yes\" if you want to execute all API calls to Mailgun in test mode."}}},{"key":"math","htmlDocs":"\n
title: Math
\ndescription: This extension adds custom actions to your care flow for simple mathematical operations.
\nMath
\nThis extension adds custom actions to your care flow for simple mathematical operations.
\nCustom Actions
\nSum
\nCalculate the sum of two or more addends.
\nSubtract
\nCalculate the difference between two numbers.
\nMultiply
\nMultiply a series of numbers to get a final product.
\nDivide
\nDivide two numbers.
\nGenerate random number
\nGenerates a random (whole) number that falls between the ranges of two numbers [min, max].
\nAssign to cohort
\nDeterministically assign any string value (e.g. patient ID, email, UUID) to a cohort number between 1 and a given number of cohorts. The same input will always produce the same cohort, making this action ideal for A/B testing and patient randomization.
\nInputs:
\n- \n
- Input value: Any string used to determine the cohort assignment. \n
- Number of cohorts: The total number of cohorts to distribute inputs across (must be >= 1). \n
Output:
\n- \n
- Cohort number: An integer between 1 and the number of cohorts (inclusive). \n
\n\nNote: When the number of cohorts changes, a patient's assigned cohort may change because the underlying hash modulo base changes. This action does not guarantee cohort stability across different values of the number of cohorts.
\n
Calculate date difference
\nCalculate the difference between two dates where \"date left\" is the minuend and \"date right\" the subtrahend.
\nYou can choose the unit in which you would like to see the difference expressed:
\n- \n
- Seconds: get the number of seconds between the given dates. Fractional seconds are truncated towards zero. \n
- Minutes: get the signed number of full (rounded towards 0) minutes between the given dates. Fractional minutes are truncated towards zero. \n
- Hours: get the number of hours between the given dates. Fractional hours are truncated towards zero. \n
- Days: get the number of full day periods between two dates. Fractional days are truncated towards zero. \n
- Weeks: get the number of full weeks between two dates. Fractional weeks are truncated towards zero. \n
- Months: get the number of full months between the given dates. Fractional months are truncated towards zero. \n
- Years: get the number of full years between the given dates. \n
Math changelog
","actions":{"generateRandomNumber":{"key":"generateRandomNumber","title":"Generate random number","description":"Generate a random number between a given range.","category":"Math","fields":{"min":{"id":"min","label":"Minimum number","description":"The minimum number in the range (INCLUSIVE). Should be an integer.","required":true,"type":"numeric"},"max":{"id":"max","label":"Maximum number","description":"The maximum end of the range (INCLUSIVE). Should be an integer.","required":true,"type":"numeric"}},"dataPoints":{"generatedNumber":{"key":"generatedNumber","valueType":"number"}},"previewable":true},"calculateDateDifference":{"key":"calculateDateDifference","title":"Calculate date difference","description":"Calculate the difference between 2 dates in a unit of your choice.","category":"Math","fields":{"dateLeft":{"id":"dateLeft","label":"Date left (minuend)","description":"The date from which the other date (date right) is to be subtracted.","required":true,"type":"date"},"dateRight":{"id":"dateRight","label":"Date right (subtrahend)","description":"The date to be subtracted from the other date (date left).","required":true,"type":"date"},"unit":{"id":"unit","label":"Duration unit","description":"The unit of duration","required":true,"type":"string","options":{"dropdownOptions":[{"label":"seconds","value":"seconds"},{"label":"minutes","value":"minutes"},{"label":"hours","value":"hours"},{"label":"days","value":"days"},{"label":"weeks","value":"weeks"},{"label":"months","value":"months"},{"label":"years","value":"years"}]}}},"dataPoints":{"dateDifference":{"key":"dateDifference","valueType":"number"}},"previewable":true},"subtract":{"key":"subtract","title":"Subtract","description":"Calculate the difference between two numbers","category":"Math","fields":{"minuend":{"id":"minuend","label":"Minuend","description":"","required":true,"type":"numeric"},"subtrahend":{"id":"subtrahend","label":"Subtrahend","description":"","required":true,"type":"numeric"}},"dataPoints":{"difference":{"key":"difference","valueType":"number"},"absoluteDifference":{"key":"absoluteDifference","valueType":"number"}},"previewable":true},"sum":{"key":"sum","title":"Sum","description":"Calculate the sum of two or more addends","category":"Math","fields":{"addend_01":{"id":"addend_01","label":"Addend","description":"","required":true,"type":"numeric"},"addend_02":{"id":"addend_02","label":"Addend","description":"","required":true,"type":"numeric"},"addend_03":{"id":"addend_03","label":"Addend","description":"","required":false,"type":"numeric"},"addend_04":{"id":"addend_04","label":"Addend","description":"","required":false,"type":"numeric"},"addend_05":{"id":"addend_05","label":"Addend","description":"","required":false,"type":"numeric"},"addend_06":{"id":"addend_06","label":"Addend","description":"","required":false,"type":"numeric"},"addend_07":{"id":"addend_07","label":"Addend","description":"","required":false,"type":"numeric"},"addend_08":{"id":"addend_08","label":"Addend","description":"","required":false,"type":"numeric"},"addend_09":{"id":"addend_09","label":"Addend","description":"","required":false,"type":"numeric"},"addend_10":{"id":"addend_10","label":"Addend","description":"","required":false,"type":"numeric"},"addend_11":{"id":"addend_11","label":"Addend","description":"","required":false,"type":"numeric"},"addend_12":{"id":"addend_12","label":"Addend","description":"","required":false,"type":"numeric"},"addend_13":{"id":"addend_13","label":"Addend","description":"","required":false,"type":"numeric"},"addend_14":{"id":"addend_14","label":"Addend","description":"","required":false,"type":"numeric"},"addend_15":{"id":"addend_15","label":"Addend","description":"","required":false,"type":"numeric"},"addend_16":{"id":"addend_16","label":"Addend","description":"","required":false,"type":"numeric"},"addend_17":{"id":"addend_17","label":"Addend","description":"","required":false,"type":"numeric"},"addend_18":{"id":"addend_18","label":"Addend","description":"","required":false,"type":"numeric"},"addend_19":{"id":"addend_19","label":"Addend","description":"","required":false,"type":"numeric"},"addend_20":{"id":"addend_20","label":"Addend","description":"","required":false,"type":"numeric"}},"dataPoints":{"sum":{"key":"sum","valueType":"number"}},"previewable":true},"divide":{"key":"divide","title":"Divide","description":"Divide two numbers","category":"Math","fields":{"dividend":{"id":"dividend","label":"Dividend","description":"","required":true,"type":"numeric"},"divisor":{"id":"divisor","label":"Divisor","description":"","required":true,"type":"numeric"}},"dataPoints":{"quotient":{"key":"quotient","valueType":"number"}},"previewable":true},"multiply":{"key":"multiply","title":"Multiply","description":"Multiply a series of numbers to get a final product","category":"Math","fields":{"factor_01":{"id":"factor_01","label":"Factor","description":"","required":true,"type":"numeric"},"factor_02":{"id":"factor_02","label":"Factor","description":"","required":true,"type":"numeric"},"factor_03":{"id":"factor_03","label":"Factor","description":"","required":false,"type":"numeric"},"factor_04":{"id":"factor_04","label":"Factor","description":"","required":false,"type":"numeric"},"factor_05":{"id":"factor_05","label":"Factor","description":"","required":false,"type":"numeric"},"factor_06":{"id":"factor_06","label":"Factor","description":"","required":false,"type":"numeric"},"factor_07":{"id":"factor_07","label":"Factor","description":"","required":false,"type":"numeric"},"factor_08":{"id":"factor_08","label":"Factor","description":"","required":false,"type":"numeric"},"factor_09":{"id":"factor_09","label":"Factor","description":"","required":false,"type":"numeric"},"factor_10":{"id":"factor_10","label":"Factor","description":"","required":false,"type":"numeric"},"factor_11":{"id":"factor_11","label":"Factor","description":"","required":false,"type":"numeric"},"factor_12":{"id":"factor_12","label":"Factor","description":"","required":false,"type":"numeric"},"factor_13":{"id":"factor_13","label":"Factor","description":"","required":false,"type":"numeric"},"factor_14":{"id":"factor_14","label":"Factor","description":"","required":false,"type":"numeric"},"factor_15":{"id":"factor_15","label":"Factor","description":"","required":false,"type":"numeric"},"factor_16":{"id":"factor_16","label":"Factor","description":"","required":false,"type":"numeric"},"factor_17":{"id":"factor_17","label":"Factor","description":"","required":false,"type":"numeric"},"factor_18":{"id":"factor_18","label":"Factor","description":"","required":false,"type":"numeric"},"factor_19":{"id":"factor_19","label":"Factor","description":"","required":false,"type":"numeric"},"factor_20":{"id":"factor_20","label":"Factor","description":"","required":false,"type":"numeric"}},"dataPoints":{"product":{"key":"product","valueType":"number"}},"previewable":true},"assignToCohort":{"key":"assignToCohort","title":"Assign to cohort","description":"Deterministically assign a value to a cohort number. Given the same input and number of cohorts, the result will always be the same.","category":"Math","fields":{"input":{"id":"input","label":"Input value","description":"Any string value used to determine the cohort assignment (e.g. patient ID, hash, email). The same input will always produce the same cohort.","required":true,"type":"string"},"numberOfCohorts":{"id":"numberOfCohorts","label":"Number of cohorts","description":"The total number of cohorts to distribute inputs across. Must be an integer greater than or equal to 1.","required":true,"type":"numeric"}},"dataPoints":{"cohortNumber":{"key":"cohortNumber","valueType":"number"}},"previewable":true}},"webhooks":[],"description":"The Math extension provides some useful actions to perform simple mathematical operations.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1679592864/Awell%20Extensions/maths.png","category":"Math","title":"Math","settings":{},"author":{"authorType":"Awell"}},{"key":"messagebird","htmlDocs":"\n
title: MessageBird
\ndescription: MessageBird is a cloud-based SMS marketing platform designed to help businesses engage with customers across a variety of channels including WhatsApp, voice, live chat and more.
\nMessageBird
\nMessageBird is a cloud-based SMS marketing platform designed to help businesses engage with customers across a variety of channels including WhatsApp, voice, live chat and more.
\nExtension settings
\nIn order to set up this extension, you will need to provide a MessageBird API key and report URL (only required if you want to use WhatsApp messaging).
\nCustom Actions
\nSend SMS
\nMessageBird's Programmable SMS API enables you to programmatically send SMS messages from within a care flow.
\nRead the official documentation
\nSend voice (text-to-speech) message
\nMessageBird's Voice Messaging API enables you to transform text messages into voice messages to any country.
\nRead the official documentation
\nSend WhatsApp message
\nSend a message to a recipient via WhatsApp. If an active conversation already exists for the recipient, the conversation will be resumed. In case there's no active conversation a new one is created.
\nLearn how to get started with MessageBird and WhatsApp
","changelog":"MessageBird changelog
","actions":{"sendSms":{"key":"sendSms","title":"Send SMS","description":"Send an SMS to a recipient of your choice.","category":"Communication","fields":{"originator":{"id":"originator","label":"Originator","description":"The sender of the message. This can be a telephone number (including country code) or an alphanumeric string.","type":"string","required":true},"recipient":{"id":"recipient","label":"Recipient","description":"The mobile number of the recipient.","type":"string","stringType":"phone","required":true},"body":{"id":"body","label":"Body","description":"The content of your message.","type":"text","required":true}},"previewable":true},"sendWhatsAppMessage":{"key":"sendWhatsAppMessage","title":"Send WhatsApp message","description":"Send a WhatsApp message to a recipient of your choice.","category":"Communication","fields":{"from":{"id":"from","label":"From","description":"The channel ID from which the message should be sent.","type":"string","required":true},"to":{"id":"to","label":"To","description":"Either a channel-specific identifier for the receiver (e.g. MSISDN for SMS or WhatsApp channels), or the ID of a MessageBird Contact.","type":"string","stringType":"phone","required":true},"content":{"id":"content","label":"Content","description":"The content of your message.","type":"text","required":true}},"previewable":true},"sendVoiceMessage":{"key":"sendVoiceMessage","title":"Send voice message","description":"Send a voice message to a recipient of your choice.","category":"Communication","fields":{"originator":{"id":"originator","label":"Originator","description":"The sender of the message. This can be a telephone number (including country code) or an alphanumeric string.","type":"string","required":false},"recipient":{"id":"recipient","label":"Recipient","description":"The mobile number of the recipient.","type":"string","stringType":"phone","required":true},"body":{"id":"body","label":"Body","description":"The content of your message.","type":"text","required":true},"language":{"id":"language","label":"Language","description":"The language in which the message needs to be read to the recipient. Default: en-gb.","type":"string","required":false},"voice":{"id":"voice","label":"Voice","description":"The voice in which the messages needs to be read to the recipient. Possible values are: `male`, `female`. Default: `female`","type":"string","required":false}},"previewable":true}},"webhooks":[],"description":"MessageBird is a cloud-based communication platform with support for a variety of channels including WhatsApp, voice, live chat and more.","icon_url":"https://developers.messagebird.com/img/glyph.svg","title":"MessageBird","category":"Communication","author":{"authorType":"Awell"},"settings":{"apiKey":{"label":"API Key","key":"apiKey","obfuscated":true,"required":true,"description":"Your MessageBird API key."},"reportUrl":{"label":"Report URL","key":"reportUrl","obfuscated":false,"required":false,"description":"The URL for delivery of status reports for messages. Must be HTTPS."}}},{"key":"medplum","htmlDocs":"\n
title: Medplum
\ndescription: Medplum is the open source healthcare developer platform that helps you build, test, and deliver any healthcare product or service.
\nMedplum
\nMedplum is the open source healthcare developer platform that helps you build, test, and deliver any healthcare product or service.
\nExtension settings
\nThe following settings are required to configure the Medplum extension:
\n- \n
- Client ID: Used to authenticate with Medplum's API (required) \n
- Client Secret: Used to authenticate with Medplum's API (required) \n
- Base URL: Optional custom base URL for your Medplum server (e.g.,
https://api.medplum.com/). Leave empty to use the default Medplum server. \n
Medplum changelog
","actions":{"getPatient":{"key":"getPatient","title":"Get patient","description":"Retrieve patient details from Medplum","category":"EHR Integrations","fields":{"patientId":{"id":"patientId","label":"Patient ID","description":"The identifier of the patient in Medplum","type":"string","required":true}},"previewable":true,"dataPoints":{"patientData":{"key":"patientData","valueType":"json"},"patientFirstName":{"key":"patientFirstName","valueType":"string"},"patientLastName":{"key":"patientLastName","valueType":"string"},"patientDob":{"key":"patientDob","valueType":"date"},"patientGender":{"key":"patientGender","valueType":"string"}}},"createPatient":{"key":"createPatient","title":"Create patient","description":"Create a patient in Medplum","category":"EHR Integrations","fields":{"firstName":{"id":"firstName","label":"First name","description":"","type":"string","required":false},"lastName":{"id":"lastName","label":"Last name","description":"","type":"string","required":false},"mobilePhone":{"id":"mobilePhone","label":"Mobile phone","description":"","type":"string","stringType":"phone","required":false},"email":{"id":"email","label":"Email","description":"","type":"string","required":false},"birthDate":{"id":"birthDate","label":"Birth date","description":"","type":"date","required":false},"gender":{"id":"gender","label":"Gender","description":"Valid values are \"male\", \"female\", \"other\", \"unknown\"","type":"string","required":false},"address":{"id":"address","label":"Address","description":"","type":"string","required":false},"city":{"id":"city","label":"City","description":"","type":"string","required":false},"state":{"id":"state","label":"State","description":"","type":"string","required":false},"country":{"id":"country","label":"Country","description":"","type":"string","required":false},"postalCode":{"id":"postalCode","label":"Postal code","description":"","type":"string","required":false}},"previewable":false,"dataPoints":{"patientId":{"key":"patientId","valueType":"string"}}},"getAppointment":{"key":"getAppointment","title":"Get appointment","description":"Retrieve appointment details from Medplum","category":"EHR Integrations","fields":{"appointmentId":{"id":"appointmentId","label":"Appointment ID","description":"The identifier of the appointment in Medplum","type":"string","required":true}},"previewable":true,"dataPoints":{"appointmentData":{"key":"appointmentData","valueType":"json"}}},"executeBot":{"key":"executeBot","title":"Execute Bot","description":"Execute a Medplum Bot","category":"EHR Integrations","fields":{"botId":{"id":"botId","label":"Bot ID","description":"You can find the id of your Bot by clicking on the Details tab of the Bot resource in the Medplum app","type":"string","required":true},"body":{"id":"body","label":"Body","description":"Data in JSON format you would like to pass to the Bot","type":"json","required":false}},"previewable":false,"dataPoints":{"data":{"key":"data","valueType":"string"},"jsonData":{"key":"jsonData","valueType":"json"}}},"createTask":{"key":"createTask","title":"Create task","description":"Create a Task in Medplum","category":"EHR Integrations","fields":{"patientId":{"id":"patientId","label":"Patient ID","description":"ID of the patient in Medplum the task is for","type":"string","required":true},"taskTitle":{"id":"taskTitle","label":"Task name","description":"Briefly describes what the task involves","type":"string","required":true},"description":{"id":"description","label":"Description name","description":"Human-readable explanation of task","type":"text","required":false},"status":{"id":"status","label":"Status","description":"The status of the task","type":"string","required":true,"options":{"dropdownOptions":[{"label":"draft","value":"draft"},{"label":"requested","value":"requested"},{"label":"received","value":"received"},{"label":"accepted","value":"accepted"},{"label":"rejected","value":"rejected"},{"label":"ready","value":"ready"},{"label":"cancelled","value":"cancelled"},{"label":"in-progress","value":"in-progress"},{"label":"on-hold","value":"on-hold"},{"label":"failed","value":"failed"},{"label":"completed","value":"completed"},{"label":"entered-in-error","value":"entered-in-error"}]}},"intent":{"id":"intent","label":"Intent","description":"Indicates the \"level\" of actionability associated with the Task.","type":"string","required":true,"options":{"dropdownOptions":[{"label":"unknown","value":"unknown"},{"label":"proposal","value":"proposal"},{"label":"plan","value":"plan"},{"label":"order","value":"order"},{"label":"original-order","value":"original-order"},{"label":"reflex-order","value":"reflex-order"},{"label":"filler-order","value":"filler-order"},{"label":"instance-order","value":"instance-order"},{"label":"option","value":"option"}]}},"priority":{"id":"priority","label":"Priority","description":"The priority of the task","type":"string","required":false,"options":{"dropdownOptions":[{"label":"routine","value":"routine"},{"label":"urgent","value":"urgent"},{"label":"asap","value":"asap"},{"label":"stat","value":"stat"}]}},"dueDate":{"id":"dueDate","label":"Due date","description":"","type":"date","required":false},"performerType":{"id":"performerType","label":"Performer type","description":"Indicate which role can/should perform this task","type":"string","required":false}},"previewable":false,"dataPoints":{"taskId":{"key":"taskId","valueType":"string"}}},"createServiceRequest":{"key":"createServiceRequest","title":"Create service request","description":"Create a service request in Medplum","category":"EHR Integrations","fields":{"patientId":{"id":"patientId","label":"Patient ID","description":"ID of the patient in Medplum","type":"string","required":true},"status":{"id":"status","label":"Status","description":"The status of the order","type":"string","required":true,"options":{"dropdownOptions":[{"label":"draft","value":"draft"},{"label":"active","value":"active"},{"label":"on-hold","value":"on-hold"},{"label":"revoked","value":"revoked"},{"label":"completed","value":"completed"},{"label":"entered-in-error","value":"entered-in-error"},{"label":"unknown","value":"unknown"}]}},"intent":{"id":"intent","label":"Mobile phone","description":"Whether the request is a proposal, plan, an original order or a reflex order.","type":"string","required":true,"options":{"dropdownOptions":[{"label":"proposal","value":"proposal"},{"label":"plan","value":"plan"},{"label":"directive","value":"directive"},{"label":"order","value":"order"},{"label":"original-order","value":"original-order"},{"label":"reflex-order","value":"reflex-order"},{"label":"filler-order","value":"filler-order"},{"label":"instance-order","value":"instance-order"},{"label":"option","value":"option"}]}},"priority":{"id":"priority","label":"Priority","description":"The priority of the order","type":"string","required":false,"options":{"dropdownOptions":[{"label":"routine","value":"routine"},{"label":"urgent","value":"urgent"},{"label":"asap","value":"asap"},{"label":"stat","value":"stat"}]}}},"previewable":false,"dataPoints":{"serviceRequestId":{"key":"serviceRequestId","valueType":"string"}}},"submitQuestionnaireResponse":{"key":"submitQuestionnaireResponse","title":"Submit questionnaire response","description":"Creates a questionnaire response in Medplum for the latest submitted form in the current step","category":"EHR Integrations","fields":{"patientId":{"id":"patientId","label":"Patient ID","description":"The identifier of the patient in Medplum to assign the response to","type":"string","required":true}},"previewable":false,"dataPoints":{"questionnnaireResponseId":{"key":"questionnnaireResponseId","valueType":"string"}}},"createCalculationObservation":{"key":"createCalculationObservation","title":"Create calculation observation","description":"Create a calculation observation in Medplum","category":"EHR Integrations","fields":{"patientId":{"id":"patientId","label":"Patient ID","description":"The identifier of the patient in Medplum to assign the response to","type":"string","required":true},"questionnaireResponseId":{"id":"questionnaireResponseId","label":"Questionnaire response ID","description":"The identifier of the questionnaire response you want to link the calculation result to","type":"string","required":false}},"previewable":false,"dataPoints":{"observationId":{"key":"observationId","valueType":"string"}}},"addSideEffect":{"key":"addSideEffect","title":"Add side effect","description":"Add side effect to Medication Request","category":"EHR Integrations","fields":{"medicationRequestId":{"id":"medicationRequestId","label":"The ID of the medication request you want to link the side effec to","description":"","type":"string","required":true},"sideEffect":{"id":"sideEffect","label":"Side effect","description":"","type":"string","required":true}},"previewable":false,"dataPoints":{}},"getServiceRequest":{"key":"getServiceRequest","title":"Get service request","description":"Retrieve service request details from Medplum","category":"EHR Integrations","fields":{"resourceId":{"id":"resourceId","label":"Resource ID","description":"The resource ID of the ServiceRequest in Medplum","type":"string","required":true}},"previewable":true,"dataPoints":{"serviceRequestResource":{"key":"serviceRequestResource","valueType":"json"},"status":{"key":"status","valueType":"string"},"intent":{"key":"intent","valueType":"string"},"priority":{"key":"priority","valueType":"string"},"patientId":{"key":"patientId","valueType":"string"}}},"getMedicationRequest":{"key":"getMedicationRequest","title":"Get medication request","description":"Retrieve medication request details from Medplum","category":"EHR Integrations","fields":{"resourceId":{"id":"resourceId","label":"Resource ID","description":"The resource ID of the MedicationRequest in Medplum","type":"string","required":true}},"previewable":true,"dataPoints":{"medicationRequest":{"key":"medicationRequest","valueType":"json"},"status":{"key":"status","valueType":"string"},"intent":{"key":"intent","valueType":"string"},"priority":{"key":"priority","valueType":"string"},"medicationDisplay":{"key":"medicationDisplay","valueType":"string"},"dosageInstructions":{"key":"dosageInstructions","valueType":"string"},"patientId":{"key":"patientId","valueType":"string"}}},"searchPatient":{"key":"searchPatient","title":"Search patient","description":"Search for patients in Medplum using parameters","category":"EHR Integrations","fields":{"parameter":{"id":"parameter","label":"Search Parameter","description":"FHIR search parameter (e.g., \"identifier\", \"name\", \"birthdate\")","type":"string","required":true},"value":{"id":"value","label":"Search Value","description":"Value to search for (e.g., \"12345\" for identifier)","type":"string","required":true}},"previewable":true,"dataPoints":{"patientData":{"key":"patientData","valueType":"json"},"searchResults":{"key":"searchResults","valueType":"json"}}},"createResource":{"key":"createResource","title":"Find or create resource","description":"Find or create any FHIR resource in Medplum. Optionally search for existing resources by type and identifier before creating. Supports single resources or FHIR Bundles (transaction/batch) for creating multiple resources atomically.","category":"EHR Integrations","fields":{"resourceJson":{"id":"resourceJson","label":"Resource JSON","description":"FHIR resource or Bundle as JSON. Supports single resources (e.g., Patient, Observation) or FHIR Bundles (transaction/batch) for creating multiple resources.","type":"json","required":true},"searchResourceType":{"id":"searchResourceType","label":"Search Resource Type","description":"Optional: FHIR resource type to search for (e.g., Patient, Observation). If provided along with Search Identifier, the action will search for existing resources before creating a new one.","type":"string","required":false},"searchIdentifier":{"id":"searchIdentifier","label":"Search Identifier","description":"Optional: Identifier value to search for (e.g., MRN, SSN). If provided along with Search Resource Type, the action will search for existing resources with this identifier before creating a new one.","type":"string","required":false}},"previewable":false,"dataPoints":{"resourceId":{"key":"resourceId","valueType":"string"},"resourceType":{"key":"resourceType","valueType":"string"},"bundleId":{"key":"bundleId","valueType":"string"},"bundleType":{"key":"bundleType","valueType":"string"},"resourceIds":{"key":"resourceIds","valueType":"string"},"resourcesCreated":{"key":"resourcesCreated","valueType":"json"},"wasResourceFound":{"key":"wasResourceFound","valueType":"boolean"}}}},"webhooks":[{"key":"patientCreated","dataPoints":{"patientId":{"key":"patientId","valueType":"string"}}},{"key":"observationCreated","dataPoints":{"observation":{"key":"observation","valueType":"json"},"observationId":{"key":"observationId","valueType":"string"}}}],"description":"Medplum is the open source healthcare developer platform that helps you build, test, and deliver any healthcare product or service.","icon_url":"https://www.medplum.com/img/logo.svg","title":"Medplum","category":"EHR Integrations","author":{"authorType":"Awell"},"settings":{"clientId":{"key":"clientId","label":"Client ID","obfuscated":true,"required":true,"description":"Used to authenticate with Medplum"},"clientSecret":{"key":"clientSecret","label":"Client secret","obfuscated":true,"required":true,"description":"Used to authenticate with Medplum"},"baseUrl":{"key":"baseUrl","label":"Base URL","obfuscated":false,"required":false,"description":"Optional custom base URL for Medplum server (e.g., https://api.medplum.com/). Leave empty to use default."}}},{"key":"metriport","htmlDocs":"\n
title: Metriport
\ndescription: Metriport is Plaid for healthcare data.
\nMetriport
\nMetriport is Plaid for healthcare data. We help digital health companies access and manage patient health and medical data, through an open-source and universal API.
\nThrough a single integration, our API enables modern health companies to get the comprehensive patient data they need from both HIEs and EHRs, as well as popular wearable devices.
\nAs a developer-first interoperability solution, Metriport is powering the next wave of innovative companies, accelerating a revolution in digital health.
\nTo learn more visit https://www.metriport.com/
\nExtension settings
\nIn order to set up this extension, you will need to provide a Metriport API key. You can obtain an API key via the Metriport dashboard by selecting the Developers tab. To learn more on how to get started with Metriport visit our quick start docs for our Medical API. Also, to better understand how our API keys work check out the API Keys section of our docs as well.
Custom Actions
\nGENERAL NOTE: Make sure to create Organizations and Facilities in Metriport before using this extension. A Patient must be associated with a Facility by providing the facilityId when stated in the actions.
\nCreate Patient
\nCreates a Patient in Metriport for the specified Facility where the Patient is receiving care.
\nVisit endpoint docs for more info.
\nUpdate Patient
\nUpdates the specified Patient.
\nVisit endpoint docs for more info.
\nGet Patient
\nRetrieves the specified Patient.
\nVisit endpoint docs for more info.
\nRemove Patient
\nRemoves a Patient at Metriport and at HIEs the Patient is linked to.
\nVisit endpoint docs for more info.
\nList Documents
\nLists all Documents that can be retrieved for a Patient.
\nVisit endpoint docs for more info.
\nNOTE: It also returns the status of querying Document references across HIEs, indicating whether there is an asynchronous query in progress (status processing) or not (status completed). If the query is in progress, you will also receive the total number of Documents to be queried as well as the ones that have already been completed.
\nQuery Documents
\nTriggers a Document query for the specified Patient across HIEs.
\nVisit endpoint docs for more info.
\nNOTE: When executed, this endpoint triggers an asynchronous Document query with HIEs and immediately returns the status of Document query, processing .
\nGet Document Url
\nGets a presigned URL for downloading the specified Document.
\nVisit endpoint docs for more info.
\nNOTE: This endpoint returns a URL which you can use to download the specified Document using the file name provided from the List Documents endpoint.
\nMore Info
\nFor more information on how to integrate with Metriport please visit our Medical API docs
","changelog":"Metriport changelog
","actions":{"getPatient":{"key":"getPatient","title":"Get Patient","description":"Gets a Patient.","category":"EHR Integrations","fields":{"patientId":{"id":"patientId","label":"Patient ID","description":"The Patient ID","type":"string","required":true}},"previewable":true,"dataPoints":{"firstName":{"key":"firstName","valueType":"string"},"lastName":{"key":"lastName","valueType":"string"},"dob":{"key":"dob","valueType":"date"},"genderAtBirth":{"key":"genderAtBirth","valueType":"string"},"driversLicenseValue":{"key":"driversLicenseValue","valueType":"string"},"driversLicenseState":{"key":"driversLicenseState","valueType":"string"},"addressLine1":{"key":"addressLine1","valueType":"string"},"addressLine2":{"key":"addressLine2","valueType":"string"},"city":{"key":"city","valueType":"string"},"state":{"key":"state","valueType":"string"},"zip":{"key":"zip","valueType":"string"},"country":{"key":"country","valueType":"string"},"phone":{"key":"phone","valueType":"string"},"email":{"key":"email","valueType":"string"}}},"createPatient":{"key":"createPatient","title":"Create Patient","description":"Creates a Patient in Metriport for the specified Facility where the Patient is receiving care.","category":"EHR Integrations","fields":{"facilityId":{"id":"facilityId","label":"Facility ID","description":"The ID of the facility to create the Patient in","type":"string","required":true},"firstName":{"id":"firstName","label":"First Name","description":"The Patient's first name","type":"string","required":true},"lastName":{"id":"lastName","label":"Last Name","description":"The Patient's last name","type":"string","required":true},"dob":{"id":"dob","label":"Date of Birth","description":"The Patient's date of birth (DOB), formatted YYYY-MM-DD","type":"string","required":true},"genderAtBirth":{"id":"genderAtBirth","label":"Gender at Birth","description":"The Patient's gender at birth, can be one of M or F","type":"string","required":true},"driversLicenseValue":{"id":"driversLicenseValue","label":"Drivers License Value","description":"The Patient's driver's license number","type":"string"},"driversLicenseState":{"id":"driversLicenseState","label":"Drivers License State","description":"The 2 letter state acronym where this ID was issued, for example: CA","type":"string"},"addressLine1":{"id":"addressLine1","label":"Address Line 1","description":"The address","type":"string","required":true},"addressLine2":{"id":"addressLine2","label":"Address Line 2","description":"The address details","type":"string"},"city":{"id":"city","label":"City","description":"The city","type":"string","required":true},"state":{"id":"state","label":"State","description":"The 2 letter state acronym, for example: CA","type":"string","required":true},"zip":{"id":"zip","label":"Zip","description":"5 digit zip code","type":"string","required":true},"country":{"id":"country","label":"Country","description":"Must be “USA”","type":"string","required":true},"phone":{"id":"phone","label":"Phone","description":"The Patient's 10 digit phone number, formatted 1234567899","type":"string"},"email":{"id":"email","label":"Email","description":"The Patient's email address","type":"string"}},"previewable":true,"dataPoints":{"patientId":{"key":"patientId","valueType":"string"}}},"updatePatient":{"key":"updatePatient","title":"Update Patient","description":"Updates the specified Patient.","category":"EHR Integrations","fields":{"id":{"id":"id","label":"Patient ID","description":"The ID of the Patient to update","type":"string","required":true},"facilityId":{"id":"facilityId","label":"Facility ID","description":"The ID of the facility to create the Patient in","type":"string","required":true},"firstName":{"id":"firstName","label":"First Name","description":"The Patient's first name","type":"string","required":true},"lastName":{"id":"lastName","label":"Last Name","description":"The Patient's last name","type":"string","required":true},"dob":{"id":"dob","label":"Date of Birth","description":"The Patient's date of birth (DOB), formatted YYYY-MM-DD","type":"string","required":true},"genderAtBirth":{"id":"genderAtBirth","label":"Gender at Birth","description":"The Patient's gender at birth, can be one of M or F","type":"string","required":true},"driversLicenseValue":{"id":"driversLicenseValue","label":"Drivers License Value","description":"The Patient's driver's license number","type":"string"},"driversLicenseState":{"id":"driversLicenseState","label":"Drivers License State","description":"The 2 letter state acronym where this ID was issued, for example: CA","type":"string"},"addressLine1":{"id":"addressLine1","label":"Address Line 1","description":"The address","type":"string","required":true},"addressLine2":{"id":"addressLine2","label":"Address Line 2","description":"The address details","type":"string"},"city":{"id":"city","label":"City","description":"The city","type":"string","required":true},"state":{"id":"state","label":"State","description":"The 2 letter state acronym, for example: CA","type":"string","required":true},"zip":{"id":"zip","label":"Zip","description":"5 digit zip code","type":"string","required":true},"country":{"id":"country","label":"Country","description":"Must be “USA”","type":"string","required":true},"phone":{"id":"phone","label":"Phone","description":"The Patient's 10 digit phone number, formatted 1234567899","type":"string"},"email":{"id":"email","label":"Email","description":"The Patient's email address","type":"string"}},"previewable":true},"deletePatient":{"key":"deletePatient","title":"Delete Patient","description":"Removes the specified Patient.","category":"EHR Integrations","fields":{"patientId":{"id":"patientId","label":"Patient ID","description":"The Patient ID","type":"string","required":true},"facilityId":{"id":"facilityId","label":"Facility ID","description":"The facility ID","type":"string","required":true}},"previewable":true},"listDocuments":{"key":"listDocs","title":"List Documents","description":"Queries for all available document metadata for the specified patient across HIEs.","category":"EHR Integrations","fields":{"patientId":{"id":"patientId","label":"Patient ID","description":"The ID of the Patient for which to list their available Documents","type":"string","required":true}},"previewable":true,"dataPoints":{"documents":{"key":"documents","valueType":"json"}}},"queryDocs":{"key":"queryDocs","title":"Start Document Query","description":"Triggers a document query for the specified patient across HIEs.","category":"EHR Integrations","fields":{"patientId":{"id":"patientId","label":"Patient ID","description":"The ID of the Patient for which to query Documents across HIEs","type":"string","required":true},"facilityId":{"id":"facilityId","label":"Facility ID","description":"The facility providing the NPI to support this operation. Optional if the patient has only one facility.","type":"string"}},"previewable":true,"dataPoints":{"downloadStatus":{"key":"downloadStatus","valueType":"string"},"downloadTotal":{"key":"downloadTotal","valueType":"number"},"downloadSuccessful":{"key":"downloadSuccessful","valueType":"number"},"requestId":{"key":"requestId","valueType":"string"}}},"getUrl":{"key":"getUrl","title":"Get Document URL","description":"Fetches the document from S3 and sends a presigned URL.","category":"EHR Integrations","fields":{"fileName":{"id":"fileName","label":"File Name","description":"The file name of the document","type":"string","required":true}},"previewable":true,"dataPoints":{"url":{"key":"url","valueType":"string"}}},"startNetworkQuery":{"key":"startNetworkQuery","title":"Start Network Query","description":"Triggers an asynchronous query for the specified Patient across available health data networks (HIEs, pharmacies, labs). Results are sent via webhooks.","category":"EHR Integrations","fields":{"patientId":{"id":"patientId","label":"Patient ID","description":"The ID of the Patient for which to query health data","type":"string","required":true}},"previewable":false,"dataPoints":{"requestId":{"key":"requestId","valueType":"string"},"status":{"key":"status","valueType":"string"}}},"startConsolidatedQuery":{"key":"startConsolidatedQuery","title":"Start Consolidated Data Query","description":"Starts an asynchronous query for the Patient's consolidated FHIR data. Results are sent via webhooks.","category":"EHR Integrations","fields":{"patientId":{"id":"patientId","label":"Patient ID","description":"The ID of the Patient whose consolidated data to query","type":"string","required":true},"resources":{"id":"resources","label":"Resource Types","description":"Optional comma-separated list of FHIR resource types to filter by (e.g. \"Condition,Observation,MedicationRequest\"). If empty, all resource types are returned.","type":"string"},"dateFrom":{"id":"dateFrom","label":"Date From","description":"Optional start date to filter resources by (inclusive), formatted YYYY-MM-DD","type":"string"},"dateTo":{"id":"dateTo","label":"Date To","description":"Optional end date to filter resources by (inclusive), formatted YYYY-MM-DD","type":"string"},"conversionType":{"id":"conversionType","label":"Conversion Type","description":"How to render the medical record: \"json\" (default), \"pdf\", or \"html\"","type":"string"}},"previewable":false,"dataPoints":{"status":{"key":"status","valueType":"string"},"requestId":{"key":"requestId","valueType":"string"}}},"getConsolidatedQueryStatus":{"key":"getConsolidatedQueryStatus","title":"Get Consolidated Data Query Status","description":"Gets the status of a consolidated data query for a Patient. Use after starting a consolidated query to check if results are ready.","category":"EHR Integrations","fields":{"patientId":{"id":"patientId","label":"Patient ID","description":"The ID of the Patient whose consolidated data query status to check","type":"string","required":true}},"previewable":true,"dataPoints":{"status":{"key":"status","valueType":"string"},"queries":{"key":"queries","valueType":"json"}}}},"webhooks":[],"description":"Metriport helps digital health companies access and manage health and medical data, through a single universal API.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1689856160/Awell%20Extensions/metriport.png","title":"Metriport","category":"EHR Integrations","author":{"authorType":"External","authorName":"Metriport"},"settings":{"apiKey":{"key":"apiKey","label":"API Key","obfuscated":true,"description":"The API Key for the Metriport Medical API.","required":true},"baseUrl":{"key":"baseUrl","label":"Base URL","obfuscated":false,"description":"The base URL of the Metriport Medical API.","required":false}}},{"key":"nexuzhealth","htmlDocs":"\n
title: nexuzhealth
\ndescription: Demo extension for nexuzhealth
\nThis is an extension that can only be used for demo purposes.
","changelog":"nexuzhealth changelog
","actions":{"sendQuestionnaire":{"key":"sendQuestionnaire","title":"Stuur vragenlijst (mynexuzhealth)","description":"Trigger a questionaire in the mynexuzhealth app","category":"Communication","fields":{"questionnaireId":{"id":"questionnaireId","label":"Vragenlijst","type":"string","description":"Selecteer de vragenlijst die de patiënt moet invullen","required":true}},"previewable":false},"sendMessage":{"key":"sendMessage","title":"Stuur bericht (mynexuzhealth)","description":"Trigger a message in the mynexuzhealth app","category":"Communication","fields":{"subject":{"id":"subject","label":"Onderwerp","type":"string","required":true},"body":{"id":"body","label":"Bericht","type":"html","required":true}},"previewable":false},"sendDocumentation":{"key":"sendDocumentation","title":"Stuur documentatie (mynexuzhealth)","description":"Trigger documentation in the mynexuzhealth app","category":"Communication","fields":{"documentationId":{"id":"documentationId","label":"Documentation","type":"string","description":"Selecteer de documentatie die je beschikbaar wil maken","required":true}},"previewable":false}},"webhooks":[],"description":"Nexuzhealth develops KWS (Klinisch Werkstation), an EHR for hospitals, healthcare institutions, home nursing, and general practitioners.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1702299062/Awell%20Extensions/nexuzhealth.png","title":"nexuzhealth","category":"Demo","author":{"authorType":"Awell"},"settings":{}},{"key":"rest","htmlDocs":"\n
title: REST
\ndescription: A utility extension with more advanced options to make REST API calls
\nREST
\nThis is a utility extension with more advanced options to make REST API calls.
\nCustom Actions
\nPOST
\nMakes a POST request using fetch to the provided endpoint.
","changelog":"REST changelog
","actions":{"post":{"key":"post","title":"POST request","description":"Make a POST request","category":"Data","fields":{"endpoint":{"id":"endpoint","label":"Endpoint","description":"","type":"string","required":true},"headers":{"id":"headers","label":"Headers","description":"","type":"json","required":false},"jsonPayload":{"id":"jsonPayload","label":"JSON payload","description":"","type":"json","required":true},"additionalPayload":{"id":"additionalPayload","label":"Additional payload","description":"The JSON payload and additional payload will be merged into a single payload","type":"json","required":false}},"dataPoints":{"response":{"key":"response","valueType":"json"},"statusCode":{"key":"statusCode","valueType":"number"}},"previewable":true}},"webhooks":[],"description":"A utility extension with more advanced options to make REST API calls","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1724322431/Awell%20Extensions/REST_socialmedia.webp","title":"REST","category":"Data","author":{"authorType":"Awell"},"settings":{}},{"key":"sendbird","htmlDocs":"\n
title: Sendbird
\ndescription: Sendbird is a cloud-based chat and messaging platform that enables developers to integrate real-time messaging functionality into their applications.
\nSendbird
\nSendbird is a cloud-based chat and messaging platform that enables developers to integrate real-time messaging functionality into their applications.
\nSendbird offers a range of features, including real-time chat, group chat, one-on-one messaging, push notifications, and file sharing. It supports various platforms and programming languages, making it flexible and accessible for developers to integrate with different applications.
\nExtension settings
\nIn order to set up this extension, you will need:
\n- \n
- An Application ID - visit https://dashboard.sendbird.com/ to retrieve Application ID for the app of your choosing \n
- A Chat API token - visit Application's settings and go to Settings > Application > General > API tokens to retrieve either Master API token or Secondary API token \n
- A Desk API token - visit Application's settings and go to Settings > Desk > Credentials to retrieve Desk API token \n
Custom Actions
\nCreate user
\nCreates a user in Sendbird using the Chat API. See Update metadata to check metadata field details. The userId of the newly created user is then saved as a data point.
Update user
\nUpdates a user using the Chat API.
\nPlease note that updating metadata of a user needs to be done with the Update metadata action.
Delete user
\nDeletes a user in Sendbird using the Chat API.
\nGet user
\nRetrieve information about a user using the Chat API. The following fields are saved as a data point:
\n- \n
- Nickname \n
- Access token \n
- Is active \n
- Created at \n
- Last seen at \n
- Has ever logged in \n
- Metadata (stored as string) \n
Update metadata
\nUpdates the user's metadata using the Chat API. Only updates existing or adds new fields to metadata. To delete some metedata fields, check the Delete metadata action.
\nMetadata is a JSON object that can store up to five key-value items of additional user information such as a phone number, an email address, or a long description of the user. The key must not have a comma (,) and its length is limited to 128 characters. The value must be a string and its length is limited to 190 characters.
\nDelete metadata
\nDeletes user metadata using the Chat API. Takes the key of a metadata item to be deleted (deletes one key at a time if a key is provided). If not specified, all items of the metadata are deleted.
\nDeactivate user
\nDeactivates a user, using the \"Update user\" endpoint, in the Chat API. Optionally, it can be set for the user to Leave all group channels upon deactivation.
The user is deactivated by setting is_active to false.
Activate user
\nActivates a user, using the \"Update user\" endpoint, in the Chat API. The user is activated by setting is_active to true.
Create customer
\nCreates a customer using the Desk API. Only the sendbirdId is passed and it must be an ID that already exists in Sendbird's Chat platform (eg: the userId of an existing user). The customerId of the newly created customer is stored as data point.
To add custom fields to your customer, use the Update custom fields action.
\nGet customer
\nRetrieves information on a specific customer using the Desk API. The following fields are saved as a data point:
\n- \n
- Sendbird ID \n
- Channel Type \n
- Project \n
- Created At \n
- Display Name \n
- Custom Fields (stored as string) \n
Update customer's custom fields
\nUpdates a customer's custom fields using the Desk API.
\nCustom fields is a JSON object that can store up to twenty key-value items for additional customer information such as a phone number, an email address, or a long description of the customer.
\nThe specified keys must be registered as a custom field in Settings > Customer fields of your dashboard beforehand. The key must not have a comma (,) and its length is limited to 20 characters. The value's length is limited to 190 characters.
\nCreate ticket
\nCreates a ticket using the Desk API. The ticketId of the newly created ticket is stored as data point.
Please note that the Ticket won't be shown in the Sendbird console until the user for which that Ticket was created writes a message inside the Chat.
","changelog":"Sendbird changelog
\n2023-08-22
\n- \n
- add
relatedChannelUrlsfield toCreate ticketaction \n
\n
title: Sendgrid
\ndescription: SendGrid is a cloud-based email delivery platform that provides services for sending and managing email campaigns, transactional emails, and other types of messages.
\nSendgrid
\nSendGrid is a cloud-based email delivery platform that provides services for sending and managing email campaigns, transactional emails, and other types of messages.
\nExtension settings
\nIn order to set up this extension, you will need to provide:
\n- \n
- An API key \n
- A from name \n
- A from email \n
Custom Actions
\nSend email
\nAllows for sending a plain email to a recipient.
\nSend email with a template
\nAllows for sending an email based on a template to a recipient. You can also insert variables so they are rendered in your template.
\nAdd or update contact
\nAllows adding or updating contacts. The contact to update will be determined only by the email field and any fields omitted from the request will remain as they were. A contact's ID cannot be used to update the contact.
\nPlease note that custom fields need to have been already created if you wish to set their values for the contacts being upserted. To do this, please use the \"Create Custom Field Definition\" endpoint. They also can be created in Marketing -> Custom Fields section in Sendgrid.
\nAdd and remove emails from suppression lists
\nSuppression lists (link on SendGrid's website) are unsubscribe groups. Use these actions to add an email address to any number of unsubscribe groups. You can apply a suppression add/remove to multiple groups by using comma-separated lists for the groups. Only a single email can be used. This functionality is different from SendGrid's API, which allows multiple email addresses for a single group.
\nCheck an import status
\nAllows user to check the status of contact import jobs when given a jobID. Statuses are either: pending, completed, failed, or errored.
Sendgrid changelog
\nJuly 7, 2023
\nAdded \"Add Email to Suppression Lists\" and \"Remove Email from Suppression Lists\" actions.
\nJuly 15, 2023
\nUpdated \"Add or Update Contact\" acction to create a datapoint of the Job ID.
\nAdded \"Check Import Status\" action.
\nJuly 27, 2023
\nAdds \"Finished At\" data point to the importStatus action.
","actions":{"sendEmail":{"key":"sendEmail","title":"Send email","description":"Send an email.","category":"Communication","fields":{"fromName":{"id":"fromName","label":"From name","description":"The name that will be used for the \"From\" header. When left blank, the value specified in the extension settings will be used.","type":"string","required":false},"fromEmail":{"id":"fromEmail","label":"From email","description":"The email address that will be used for the \"From\" header. When left blank, the value specified in the extension settings will be used.","type":"string","required":false},"to":{"id":"to","label":"To","description":"The email address of the recipient.","type":"string","required":true},"subject":{"id":"subject","label":"Subject","description":"The subject of your email.","type":"string","required":true},"body":{"id":"body","label":"Body","description":"The content of your message.","type":"html","required":true}},"previewable":false},"sendEmailWithTemplate":{"key":"sendEmailWithTemplate","title":"Send email with template","description":"Send an email based on a template to a recipient of your choice.","category":"Communication","fields":{"fromName":{"id":"fromName","label":"From name","description":"The name that will be used for the \"From\" header. When left blank, the value specified in the extension settings will be used.","type":"string","required":false},"fromEmail":{"id":"fromEmail","label":"From email","description":"The email address that will be used for the \"From\" header. When left blank, the value specified in the extension settings will be used.","type":"string","required":false},"to":{"id":"to","label":"To","description":"The email address of the recipient.","type":"string","required":true},"templateId":{"id":"templateId","label":"Template ID","description":"The immutable ID of a template that exists in your account.","type":"string","required":true},"subject":{"id":"subject","label":"Subject","description":"The subject of your email. If you would like to compose a dynamic subject line then pass a subject field with the template content below.","type":"string","required":false},"dynamicTemplateData":{"id":"dynamicTemplateData","label":"Template content","description":"Specify a JSON blob containing the dynamic data of your template. Read the Sendgrid documentation to learn more about dynamic template data.","type":"json","required":false}},"previewable":false},"addOrUpdateContact":{"key":"addOrUpdateContact","title":"Add or update contact","description":"Add or update contact","category":"Communication","fields":{"listIds":{"id":"listIds","label":"List IDs","description":"A comma-separated string of list IDs the contact will be added to.","type":"string","required":true},"email":{"id":"email","label":"Email","description":"The contact's primary email.","type":"string","required":true},"firstName":{"id":"firstName","label":"First Name","description":"The contact's first name.","type":"string","required":false},"lastName":{"id":"lastName","label":"Last Name","description":"The contact's last name.","type":"string","required":false},"customFields":{"id":"customFields","label":"Custom fields","description":"An object of custom field IDs and the values you want to associate with those custom fields.","type":"json","required":false}},"dataPoints":{"jobId":{"key":"jobId","valueType":"string"}},"previewable":true},"removeSuppressions":{"key":"removeSuppressions","title":"Remove Email from Suppression Lists","description":"Remove an email address from one or more suppression lists.","category":"Communication","fields":{"email":{"id":"email","label":"Email","description":"The email address you would like to remove from the suppression list","type":"string","required":true},"groups":{"id":"groups","label":"Groups","description":"A comma-separated list of group IDs (e.g. `12345, 12346`)","type":"string","required":true}},"previewable":true},"addSuppressions":{"key":"addSuppressions","title":"Add Email to Suppression Lists","description":"Adds an email to one or more suppression lists.","category":"Communication","fields":{"email":{"id":"email","label":"Email","description":"The email address you would like to suppress","type":"string","required":true},"groups":{"id":"groups","label":"Groups","description":"A comma-separated list of group IDs (e.g. `12345, 12346`)","type":"string","required":true}},"previewable":true},"importStatus":{"key":"importStatus","title":"Status of Import","description":"Get the status of an Import job","category":"Communication","fields":{"jobId":{"id":"jobId","label":"Job ID","description":"The ID of the Sendgrid Job (usually obtained from the Add or Update Contact action)","type":"string","stringType":"text","required":true},"wait_for_finished":{"id":"wait_for_finished","label":"Wait for finished","description":"If true, the action will wait for the import job to finish before completing.","type":"boolean","required":false}},"dataPoints":{"importStatus":{"key":"importStatus","valueType":"string"},"finishedAt":{"key":"finishedAt","valueType":"date"},"startedAt":{"key":"startedAt","valueType":"date"},"jobType":{"key":"jobType","valueType":"string"},"id":{"key":"id","valueType":"string"}},"previewable":true}},"webhooks":[],"description":"SendGrid is a cloud-based email delivery platform that provides services for sending and managing email campaigns, transactional emails, and other types of messages.","icon_url":"https://www.vectorlogo.zone/logos/sendgrid/sendgrid-icon.svg","title":"Sendgrid","category":"Communication","author":{"authorType":"Awell"},"settings":{"apiKey":{"key":"apiKey","label":"API Key","obfuscated":true,"required":true,"description":"Your Sendgrid API Key so the extension can authenticate with the Sendgrid API."},"fromName":{"key":"fromName","label":"From name","obfuscated":false,"required":false,"description":"The name that will be used for the \"From\" header."},"fromEmail":{"key":"fromEmail","label":"From email","obfuscated":false,"required":false,"description":"The email address that will be used for the \"From\" header."}}},{"key":"sfdc","htmlDocs":"\n
title: Salesforce
\ndescription: SFDC is a cloud-based customer relationship management (CRM) software used to manage customer data, sales processes, marketing campaigns, and customer service activities
\nSalesforce
\nSFDC is a cloud-based customer relationship management (CRM) software used to manage customer data, sales processes, marketing campaigns, and customer service activities
\nExtension settings
\nFor this extension to work, you will need to provide the below settings:
\n- \n
- Salesforce subdomain (https://
.my.salesforce.com/services/oauth2/token) \n - Client ID \n
- Client secret \n
- Username* \n
- Password* \n
Username and password are optional. When specified, the Password grant will be used to authenticate with the Salesforce API. When left blank, the Client Credentials grant will be used.
\nActions
\nCreate a Lead
\nA lead is a standard Salesforce object (sObject). You can use this action to create a Lead object.
\nUpdate a lead
\nUpdates a Lead record based on the specified data and provided Lead record ID. Field values provided replace the existing values in the Lead record (PATCH).
","changelog":"Salesforce changelog
","actions":{"createLead":{"key":"createLead","title":"Create lead","description":"Creates a new lead object in Salesforce","category":"Customer Support","fields":{"data":{"id":"data","label":"Data","description":"Information used to create the Lead","type":"json","required":true},"careFlowIdField":{"id":"careFlowIdField","label":"Care Flow ID Field","description":"The field name in Salesforce that contains the Care Flow ID. If left blank, the Care Flow ID will not be included in the update.","type":"string","required":false}},"previewable":false,"dataPoints":{"createdLeadId":{"key":"createdLeadId","valueType":"string"}}},"updateLead":{"key":"updateLead","title":"Update lead","description":"Updates an existing lead object in Salesforce","category":"Customer Support","fields":{"sObjectId":{"id":"sObjectId","label":"Lead ID","description":"The object ID of the Lead in Salesforce to update","type":"string","required":true},"data":{"id":"data","label":"Data","description":"Information used to update the Lead","type":"json","required":true}},"previewable":true,"supports_automated_retries":true,"dataPoints":{}},"getLead":{"key":"getLead","title":"Get lead","description":"Retrieve a Lead from Salesforce","category":"Customer Support","fields":{"leadId":{"id":"leadId","label":"Lead ID","description":"","type":"string","required":true}},"previewable":true,"dataPoints":{"leadData":{"key":"leadData","valueType":"json"}}}},"webhooks":[],"description":"Salesforce.com is a cloud-based customer relationship management (CRM) software used to manage customer data, sales processes, marketing campaigns, and customer service activities","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1723280338/Awell%20Extensions/logo-sfdc-netherlands-b-v-salesforce-com.jpg","title":"Salesforce","category":"Customer Support","author":{"authorType":"Awell"},"settings":{"salesforceSubdomain":{"key":"salesforceSubdomain","label":"Domain name","obfuscated":false,"required":true,"description":"The subdomain of your Salesforce tenant (e.g. \"awell\" or \"awell.sandbox\")"},"clientId":{"key":"clientId","label":"Client ID","obfuscated":false,"required":true,"description":""},"clientSecret":{"key":"clientSecret","label":"Client secret","obfuscated":true,"required":true,"description":""},"username":{"key":"username","label":"Username ","obfuscated":false,"required":false,"description":"The username of the user that the connected app is imitating. A username is only needed when using the Password grant, leave blank to use client credentials grant."},"password":{"key":"password","label":"Password ","obfuscated":true,"required":false,"description":"The password of the user that the connected app is imitating. A password is only needed when using the Password grant, leave blank to use client credentials grant"},"apiVersion":{"key":"apiVersion","label":"API version ","obfuscated":false,"required":false,"description":"Defaults to v61.0"}}},{"key":"shelly","htmlDocs":"\n
title: Shelly
\ndescription: Smart tools to help with communication, information, and summaries in your care flow.
\nShelly
\nShelly provides a set of smart tools that use artificial intelligence (most precisely Large Language Models) to help automate tasks and manage information within your care flow.
\nActions
\nBelow is a detailed look at each tool Shelly offers, what it needs to work, what it gives you back, and how to use it best.
\nCategorize Message
\nThis tool automatically analyzes and categorizes incoming messages based on a set of predefined categories that you specify. It's particularly useful for triaging patient communications and routing them to the appropriate part of your care flow based on content and urgency.
\nWhat it needs (Inputs):
\n- \n
Message(Required): The text of the message that needs categorization. \nCategories(Required): A list of predefined categories to classify against, separated by commas (e.g., \"Medication Refill,Appointment Request,Symptom Report,Insurance Question,Urgent Medical Issue\"). \n
What it gives back (Outputs):
\n- \n
Category: The determined ONE category from your predefined list. If no suitable match is found, it returns \"None\". \nExplanation: A concise explanation (in HTML format) of the reasoning behind the categorization, which can be displayed to care team or used for auditing. \n
Tips for best results:
\n- \n
- Use distinct categories that align with your clinical workflows. \n
- Categories should reflect common patient communication types in your practice. \n
- Avoid ambiguity as current Categorize Message selects only one suitable category. \n
Example:
\nInput:\n Message: \"Hello, I need a refill for my blood pressure medication (Lisinopril 20mg). I've been taking it for the past year, and I'm down to my last few pills. My prescription number is RX43821. Can you please send a refill request to my usual pharmacy? I haven't had any side effects or issues with this medication.\"\n Categories: \"Medication Refill Request,Appointment Scheduling,Non-urgent Symptom Report,Insurance/Billing Question,Urgent Medical Concern\"\n\nOutput:\n Category: \"Medication Refill Request\"\n Explanation: \"This message clearly states a need for medication refill, specifically for Lisinopril. The patient provides prescription details and mentions having no side effects or issues. The communication is straightforward and fits perfectly into the 'Medication Refill Request' category as the patient is explicitly asking for a prescription renewal rather than scheduling an appointment, reporting symptoms, asking about insurance, or expressing an urgent concern.\"\nGenerate Message
\nThis tool creates contextually appropriate, personalized communications for patients or healthcare team members based on specific clinical situations and communication needs.
\nWhat it needs (Inputs):
\n- \n
Communication Objective(Required): The clinical purpose and context of the message (e.g., \"Welcome the patient to our chronic care management program\", \"Gather initial health information before the first appointment\", \"Remind the patient about their upcoming medication refill deadline,\" \"Provide detailed preparation instructions for the upcoming colonoscopy procedure\"). \nPersonalization Input(Optional): Clinical and demographic information to personalize the message (e.g., patient name, patient demographics, any other relevant information). \nStakeholder(Optional): The intended recipient's role (e.g., \"Patient\", \"Caregiver\", \"Primary Care Provider\", \"Specialist\"). Defaults to \"Patient\". \nLanguage(Optional): The language for the message. Defaults to English. \n
What it gives back (Outputs):
\n- \n
Subject: A clinically appropriate subject line for the message. \nMessage: The complete message content (in HTML format). \n
Tips for best results:
\n- \n
- Include relevant context in the communication objective. \n
- Make sure to include all personalization details for better personalized outreach. \n
Example:
\nInput:\n Communication Objective: \"Remind the patient about their upcoming appointment and provide preparation instructions (fasting 8 hours before, come 15 minutes early).\"\n Personalization Input: \"Patient Name: Emma Johnson, Appointment Date: July 15, 2023, Appointment Time: 2:30 PM, Provider: Dr. Sarah Chen, Appointment Type: Annual Physical Exam, Fasting Required: Yes (8 hours)\"\n Stakeholder: \"Patient\"\n Language: \"English\"\n\nOutput:\n Subject: \"Reminder: Your Appointment with Dr. Chen on July 15\"\n Message: \"<p>Dear Emma,</p><p>This is a friendly reminder about your upcoming appointment:</p><p><strong>Date:</strong> July 15, 2023<br><strong>Time:</strong> 2:30 PM<br><strong>Provider:</strong> Dr. Sarah Chen<br><strong>Type:</strong> Annual Physical Exam</p><p><strong>Important Preparation Instructions:</strong></p><ul><li>Please fast for 8 hours before your appointment (water is permitted)</li><li>Arrive 15 minutes early to complete any necessary paperwork</li><li>Bring your identification and insurance information</li></ul><p>We look forward to seeing you!</p><p>Best regards,<br>The Care Team</p>\"\nMedication From Image (Experimental)
\nThis tool uses advanced image processing and AI to extract structured medication information from images of prescription labels, medication packaging, or pill bottles.
\nWhat it needs (Inputs):
\n- \n
Image URL(Required): The URL of the medication image to be processed. \n
What it gives back (Outputs):
\n- \n
Data: Structured medication information in JSON format, including elements like medication name, dosage, frequency, and instructions. \nMedication As Text: A formatted plain text version of the extracted medication information for easier human readability. \n
Tips for best results:
\n- \n
- Ensure adequate lighting and focus when capturing images. \n
- Position the camera to capture the entire medication label clearly. \n
- The tool can process various image types: \n
- Prescription labels and bottles \n
- Medication packaging and boxes \n
- Handwritten or printed medication lists \n
- Photos of medication tables or charts \n
- Images containing multiple medications \n
- For medication lists, ensure the text is clearly visible and the image is not blurry. \n
- Multiple medications in a single image will be identified and separated when possible. \n
Example:
\nInput:\n Image URL: \"https://example.com/rx_image.jpg\"\n\nOutput:\n Data: '{\"medications\":[{\"name\":\"Atorvastatin\",\"dosage\":\"40 mg\",\"frequency\":\"Once daily\",\"instructions\":\"Take in the evening\",\"prescriber\":\"Dr. Jennifer Wilson\",\"pharmacy\":\"CityHealth Pharmacy\",\"rxNumber\":\"RX80442553\",\"dateIssued\":\"2023-05-15\",\"refills\":\"2 remaining\"}]}'\n Medication As Text: \"Name: Atorvastatin\\nDosage: 40 mg\\nFrequency: Once daily\\nInstructions: Take in the evening\\nPrescriber: Dr. Jennifer Wilson\\nPharmacy: CityHealth Pharmacy\\nRx Number: RX80442553\\nDate Issued: 2023-05-15\\nRefills: 2 remaining\"\nReview Medication Extraction
\nThis tool enables qualified clinical staff to review, validate, and if necessary, correct medication information extracted from images.
\nWhat it needs (Inputs):
\n- \n
Image URL(Required): The URL of the medication image that was processed. \nExtracted Medication(Required): The structured medication data generated by the Medication From Image action. \n
What it gives back (Outputs):
\n- \n
Reviewed Data: The validated or corrected medication information in JSON format. \nReview Status: The verification status (e.g., \"Verified Without Changes\", \"Corrected\", \"Rejected\"). \n
Tips for best results:
\n- \n
- Assign this task to staff members with clinical medication knowledge. \n
- The interface presents both the original image and extracted data side-by-side. \n
- Corrections made during review are captured for quality improvement. \n
- Consider implementing this as part of a medication reconciliation workflow. \n
Summarize Care Flow
\nThis tool generates comprehensive, contextualized summaries of a patient's progress through their care flow, highlighting key activities, routes taken, and outcomes.
\nWhat it needs (Inputs):
\n- \n
Additional Instructions(Optional): Specific focus areas for the summary (e.g., \"Focus on form completions and reminder effectiveness,\" \"Summarize patient engagement patterns\"). \nStakeholder(Optional): The intended audience (e.g., \"Care Coordinator\", \"Administrator\", \"Patient\", \"Provider\"). This affects terminology and detail level. \n
What it gives back (Outputs):
\n- \n
Summary: A comprehensive summary of the care flow progress (in HTML format). All summaries include an AI-generated disclaimer for transparency and regulatory compliance. \n
Tips for best results:
\n- \n
- Use additional instructions to focus on specific care flow parts. \n
- Specify the stakeholder to ensure appropriate terminology and detail level. \n
Example:
\nInput:\n Additional Instructions: \"Focus on patient engagement with the intake forms, summarize the reminder sequence and when forms were completed.\"\n Stakeholder: \"Care Coordinator\"\n\nOutput:\n Summary: \"<p><strong>Important Notice:</strong> This is an AI-generated summary for the 'New Patient Intake' care flow (ID: cf_12345).</p><p><strong>Summary: Patient Intake Process</strong></p><p>Patient Alex Morgan (38) was enrolled in the New Patient Intake process on June 3, 2023. The care flow included three required forms: Personal Information, Medical History, and Insurance Verification.</p><p><strong>Form Completion Timeline:</strong></p><ul><li><strong>Personal Information Form:</strong> Completed immediately during enrollment (June 3)</li><li><strong>Medical History Form:</strong> Not completed initially<ul><li>First reminder sent: June 5 via email</li><li>Second reminder sent: June 8 via text message</li><li>Form completed: June 9 (after 2 reminders)</li></ul></li><li><strong>Insurance Verification Form:</strong> Not completed initially<ul><li>First reminder sent: June 5 via email</li><li>Second reminder sent: June 8 via text message</li><li>Third reminder sent: June 12 via phone call</li><li>Form completed: June 12 (after 3 reminders during call)</li></ul></li></ul><p><strong>Engagement Analysis:</strong> Patient responded to text message reminders most effectively (completed Medical History form within 24 hours of text reminder). The Insurance Verification form required additional support, which was successfully provided during the phone call reminder.</p><p><strong>Next Steps:</strong> All required intake forms have been completed. Patient is now ready for their first appointment on June 15, 2023.</p>\"\nSummarize Form
\nThis tool analyzes patient-reported data from forms and generates concise, relevant summaries that highlight key findings in question-answer pairs. It focuses on the last form in the step before this AI Action is included in.
\nWhat it needs (Inputs):
\n- \n
Summary Format(Required): Preferred format for the summary (\"Bullet Points\" or \"Paragraph\"). \nLanguage(Optional): Desired language for the summary. If not set, it automatically detects the form's language. \nAdditional Instructions(Optional): Any additional instructions like specific questions to focus on, desired level of detail, information to emphasize or exclude, etc. \n
What it gives back (Outputs):
\n- \n
Summary: A formatted summary of form responses (in HTML format). All summaries include an AI-generated disclaimer for transparency and regulatory compliance. \n
Tips for best results:
\n- \n
- Use bullet point format for symptom reports and clinical findings. \n
- Use paragraph format for narrative elements like patient experiences. \n
- Additional instructions can help prioritize significant responses and level of details for your use case needs. \n
- Remember this is a summary, not a transcript - question-answer pairs from the form won't appear verbatim, and the AI will intelligently condense unnecessary details while preserving important information. \n
Example:
\nInput:\n Summary Format: \"Bullet Points\"\n Language: \"English\"\n Additional Instructions: \"Highlight any pain scores >5, medication side effects, and changes since last assessment. Flag any responses requiring urgent clinical attention.\"\n\nOutput:\n Summary: \"<p><strong>Important Notice:</strong> This is an AI-generated summary for form responses in version 2.3 of the 'Post-Surgical Follow-up' care flow (ID: cf_789).</p><p><strong>Post-Operative Assessment Summary:</strong></p><ul><li><strong>Pain Assessment</strong>: Reports pain level of 7/10 at surgical site <span style='color:red'>(CLINICAL ATTENTION ADVISED)</span></li><li>Pain characteristics: Described as 'sharp and throbbing,' worse with movement</li><li>Pain management: Taking prescribed oxycodone-acetaminophen as directed, but reporting inadequate relief</li><li><strong>Incision Site</strong>: Reports increasing redness and warmth around incision since yesterday <span style='color:red'>(CLINICAL ATTENTION ADVISED)</span></li><li>Drainage: Minimal serous drainage, no purulence reported</li><li><strong>Functional Status</strong>: Ambulating with assistance, able to perform basic ADLs with moderate difficulty</li><li><strong>Medication Side Effects</strong>: Reports nausea and constipation with pain medication</li><li><strong>Vital Signs</strong> (self-reported): Temperature 99.8°F (37.7°C), slightly elevated from last assessment (98.6°F)</li><li><strong>Change Since Last Assessment</strong>: Patient reports increased pain and incision site changes over past 24 hours</li></ul>\"\nSummarize Forms in Step
\nThis tool analyzes data from multiple forms completed in a single step and creates summaries for each form. It processes all forms in the current step where this AI Action is included and organizes them by form title.
\nWhat it needs (Inputs):
\n- \n
Summary Format(Required): Preferred format for the summary (\"Bullet Points\" or \"Paragraph\"). \nLanguage(Optional): Desired language for the summary. If not set, it automatically detects the predominant language. \nAdditional Instructions(Optional): Any additional instructions like specific questions to focus on, desired level of detail, information to emphasize or exclude, etc. \n
What it gives back (Outputs):
\n- \n
Summary: A formatted collection of all form responses in the step, organized by form title (in HTML format). All summaries include an AI-generated disclaimer for transparency and regulatory compliance. \n
Tips for best results:
\n- \n
- Particularly valuable for multi-form assessments that gather related information. \n
- Reduces the need to read through multiple form submissions separately. \n
- Remember this is a summary, not a transcript - question-answer pairs from the forms won't appear verbatim, and the AI will intelligently condense unnecessary details while preserving important information. \n
Example:
\nInput:\n Summary Format: \"Bullet Points\"\n Language: \"Default\"\n Additional Instructions: \"Highlight key symptoms and lifestyle factors that might affect the patient's condition.\"\n\nOutput:\n Summary: \"<p><strong>Important Notice:</strong> This is an AI-generated summary for form responses in the 'Diabetes Management' care flow (ID: cf_789).</p>\n\n<p><strong>Blood Glucose Monitoring Form:</strong></p>\n<ul>\n<li>Morning readings averaging 145 mg/dL (target: <120 mg/dL)</li>\n<li>Evening readings within normal range (average 115 mg/dL)</li>\n<li>Two hypoglycemic events reported this week (both after exercise)</li>\n<li>Consistent monitoring schedule (14/14 planned measurements completed)</li>\n</ul>\n\n<p><strong>Nutrition Assessment Form:</strong></p>\n<ul>\n<li>Carbohydrate intake: 45-60g per meal, within recommended range</li>\n<li>Reported difficulty avoiding carbs at dinner social events</li>\n<li>Successfully increased vegetable consumption to 3-4 servings daily</li>\n<li>Water intake below recommendation (4 glasses vs. recommended 8)</li>\n</ul>\n\n<p><strong>Physical Activity Log:</strong></p>\n<ul>\n<li>Walking: 20 minutes daily (consistent pattern)</li>\n<li>Strength training: 2 sessions this week (target: 3 sessions)</li>\n<li>Reports joint pain in knees after longer walking sessions</li>\n<li>Activity level increases on weekends, with lower glucose readings noted after weekend activities</li>\n</ul>\"\nSummarize Track Outcome
\nThis tool analyzes the progression through a specific track in a care flow, highlighting key routes taken and outcomes.
\nWhat it needs (Inputs):
\n- \n
Instructions(Optional): Specific focus for the analysis (e.g., \"Summarize outcome, focus on semantic information in form and messages\"). \n
What it gives back (Outputs):
\n- \n
Outcome Summary: A comprehensive summary of the track's progression and outcomes (in HTML format). \n
Tips for best results:
\n- \n
- Make sure you build a care flow in a way that AI action can leverage semantic information (meaningful names of steps, labels, meaningful names of actions) \n
- NOTE: AI action does not have access to transition logic; it only can see which routes were taken and which steps were discarded. \n
Example:
\nInput:\n Instructions: \"Summarize outcome, focus on semantic information in form and messages\"\n\nOutput:\n Outcome Summary: \"<p><strong>Important Notice:</strong> This is an AI-generated summary for the 'Patient Symptom Assessment' care flow (ID: cf_567).</p><p><strong>Track Outcome Summary:</strong></p><p><strong>Outcome:</strong> The initial assessment form was completed, summarizing the patient's symptoms and concerns.</p><p><strong>Details Supporting the Outcome:</strong></p><ul><li>The initial assessment form was presented to the patient, Samantha Joe, who provided responses indicating symptoms of fever, fatigue, and shortness of breath, with a severity level of 8.</li><li>The patient confirmed having experienced these symptoms before and expressed a need for help with anxiety.</li><li>The form responses were summarized, highlighting the patient's primary concerns and symptom details.</li><li>The process concluded with the successful completion of the form summary.</li></ul>\"\nShelly changelog
","actions":{"categorizeMessage":{"key":"categorizeMessage","title":"Categorize Message","description":"Categorizes messages into predefined categories with explanation.","category":"Workflow","fields":{"messageDataPoint":{"id":"messageDataPoint","label":"Message Data Point","description":"The message to be categorized. Use this if you want to use a data point for the message.","type":"string","required":false},"message":{"id":"message","label":"Message","description":"The message to be categorized. Use this if you want to use a text for the message.","type":"text","required":false},"categories":{"id":"categories","label":"Categories","description":"List of categories (comma-separated, no spaces)","type":"string","required":true},"instructions":{"id":"instructions","label":"Instructions","description":"Add additional instructions prompt for the LLM","type":"text","required":false}},"previewable":true,"dataPoints":{"category":{"key":"category","valueType":"string"},"explanation":{"key":"explanation","valueType":"string"}}},"generateMessage":{"key":"generateMessage","title":"Generate Message","description":"Generate a personalized message","category":"Workflow","fields":{"communicationObjective":{"id":"communicationObjective","label":"Communication Objective","description":"Provide the main purpose of the message. Add any important message context.","type":"string","required":true},"personalizationInput":{"id":"personalizationInput","label":"Personalization Input","description":"[Optional] Specify the personalization input for the message (name, age, gender, date of the last checkup, etc). This is used to personalize the message to the recipient.","type":"string","required":false},"stakeholder":{"id":"stakeholder","label":"Stakeholder","description":"[Optional]Specify the recipient role; defaults to \"Patient.\" Used for personalization.","type":"string","required":false},"language":{"id":"language","label":"Language","description":"[Optional]Specify the language of the message; defaults to English.","type":"string","required":false}},"previewable":true,"dataPoints":{"subject":{"key":"subject","valueType":"string"},"message":{"key":"message","valueType":"string"}}},"medicationFromImage":{"key":"medicationFromImage","title":"Extract medication from image (Experimental)","description":"Generates structured medication list from picture ","category":"Workflow","fields":{"imageUrl":{"id":"imageUrl","label":"Image URL","description":"The URL to the uploaded image","type":"string","required":true}},"previewable":false,"dataPoints":{"data":{"key":"data","valueType":"json"},"medicationAsText":{"key":"medicationAsText","valueType":"string"}}},"parseStructuredData":{"key":"parseStructuredData","title":"Parse Structured Data","description":"Extracts structured data from unstructured text messages using a provided JSON schema.","category":"Workflow","fields":{"messageDataPoint":{"id":"messageDataPoint","label":"Message Data Point","description":"The message to parse. Use this if you want to use a data point for the message.","type":"string","required":false},"message":{"id":"message","label":"Message","description":"The message to parse. Use this if you want to use a text for the message.","type":"text","required":false},"schema":{"id":"schema","label":"Schema","description":"JSON schema defining the structure to extract from the message. Example: {\"name\": \"string\", \"age\": \"number\", \"email\": \"string\"}","type":"json","required":true},"instructions":{"id":"instructions","label":"Instructions","description":"Add additional instructions prompt for the LLM","type":"text","required":false}},"previewable":true,"dataPoints":{"parsedData":{"key":"parsedData","valueType":"json"},"explanation":{"key":"explanation","valueType":"string"},"confidenceLevel":{"key":"confidenceLevel","valueType":"number"}}},"reviewMedicationExtraction":{"key":"reviewMedicationExtraction","title":"Review medication extraction","description":"Allow a stakeholder to review the medication extraction","category":"Workflow","fields":{"imageUrl":{"id":"imageUrl","label":"Image URL","description":"The URL to the uploaded image","type":"string","required":true},"medicationData":{"id":"medicationData","label":"Medication data","description":"The medication data to review","type":"json","required":true}},"previewable":false,"dataPoints":{"validatedData":{"key":"validatedData","valueType":"json"}},"options":{"stakeholders":{"label":"Stakeholder","mode":"single"}}},"summarizeCareFlow":{"key":"summarizeCareFlow","title":"Summarize Care Flow","description":"Summarize the care flow up until now","category":"Workflow","fields":{"additionalInstructions":{"id":"additionalInstructions","label":"Additional instructions","description":"Specify additional instructions for summarization, for example format, length, what to focus on etc. If not specified, default instructions will be used.","type":"string","required":false},"stakeholder":{"id":"stakeholder","label":"Stakeholder","description":"Indicates who the summarization is intended for. Defaults to \"Clinician\"","type":"string","required":false}},"previewable":false,"dataPoints":{"summary":{"key":"summary","valueType":"string"}}},"summarizeForm":{"key":"summarizeForm","title":"Summarize Form","description":"Summarize form responses with AI. Defaults to the latest form in the current step, but can summarize all forms in the step or across the track.","category":"Workflow","fields":{"scope":{"id":"scope","label":"Scope","description":"The scope in which to look for forms. Default is \"Step\" (current step only).","type":"string","required":false,"options":{"dropdownOptions":[{"label":"Step","value":"Step"},{"label":"Track","value":"Track"}]}},"formSelection":{"id":"formSelection","label":"Form selection","description":"Whether to summarize the most recent form or all forms in the scope. Default is \"Latest\".","type":"string","required":false,"options":{"dropdownOptions":[{"label":"Latest","value":"Latest"},{"label":"All","value":"All"}]}},"summaryFormat":{"id":"summaryFormat","label":"Summary Format","description":"Format of the summary. Acceptable values are \"Bullet-points\" and \"Text paragraph\". Defaults to Bullet-points.","type":"string","required":false,"options":{"dropdownOptions":[{"label":"Bullet-points","value":"Bullet-points"},{"label":"Text paragraph","value":"Text paragraph"}]}},"language":{"id":"language","label":"Language","description":"[Optional] Language of the summarization. Defaults to the language of the form.","type":"string","required":false},"additionalInstructions":{"id":"additionalInstructions","label":"Additional Instructions","description":"[Optional] Specify additional instructions for the AI to generate the form summary. You can include details about: specific questions to focus on, desired level of detail, information to emphasize or exclude, etc.","type":"text","required":false}},"previewable":false,"dataPoints":{"summary":{"key":"summary","valueType":"string"}}},"summarizeFormsInStep":{"key":"summarizeFormsInStep","title":"Summarize Forms in Step","description":"Summarize the responses of all forms in the step with AI.","category":"Workflow","fields":{"summaryFormat":{"id":"summaryFormat","label":"Summary Format","description":"Specify the format of the summary. Acceptable values are \"Bullet-points\" and \"Text paragraph\". Defaults to Bullet-points.","type":"string","required":false},"language":{"id":"language","label":"Language","description":"[Optional] Indicates the language of the summarization. Defaults to the language of the form.","type":"string","required":false}},"previewable":false,"dataPoints":{"summary":{"key":"summary","valueType":"string"}}},"summarizeTrackOutcome":{"key":"summarizeTrackOutcome","title":"Summarize Track Outcome","description":"Summarize the care flow track outcome and activities that led to the outcome","category":"Workflow","fields":{"instructions":{"id":"instructions","label":"Instructions","description":"Specify instructions for the AI to generate the track outcome summary. You can include details about: what outcome to focus on, where to find it in the track, specific forms to analyze, desired length and format, parts of the track to exclude, level of detail for decision paths, etc.","type":"text","required":false}},"previewable":false,"dataPoints":{"outcomeSummary":{"key":"outcomeSummary","valueType":"string"}}}},"webhooks":[],"description":"Library of AI-powered actions","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1726037275/Awell%20Extensions/shelly_logo.png","title":"Shelly","category":"Workflow","author":{"authorType":"Awell"},"settings":{}},{"key":"slack","htmlDocs":"\n
title: Slack
\ndescription: Slack is a messaging platform for teams that brings all your communication together, giving everyone a shared workspace where conversations are organized and accessible.
\nSlack
\nSlack is a messaging platform for teams that brings all your communication together, giving everyone a shared workspace where conversations are organized and accessible.
\nThis extension allows you to send messages to Slack channels from your care flows, keeping your team informed about important events and updates.
\nExtension settings
\nIn order to set up this extension, you will need:
\n- \n
- A Slack App with a Bot User OAuth Token (starts with
xoxb-) \n - The bot must have the
chat:writeOAuth scope \n
Setting up your Slack App
\n- \n
- Go to https://api.slack.com/apps and click \"Create New App\" \n
- Choose \"From scratch\" and give your app a name \n
- Navigate to \"OAuth & Permissions\" in the sidebar \n
- Under \"Scopes\", add the
chat:writeBot Token Scope \n - Click \"Install to Workspace\" at the top of the page \n
- Copy the \"Bot User OAuth Token\" (starts with
xoxb-) \n - Use this token in the extension settings \n
Inviting the bot to channels
\nBefore the bot can post messages to a channel, it must be invited to that channel. You can do this by:
\n- \n
- Going to the channel in Slack \n
- Typing
/invite @YourBotName\n
Custom Actions
\nSend Message to Channel
\nSend a message to a Slack channel.
\nInput fields:
\n- \n
- Channel (required): The Slack channel to send the message to. You can use either the channel ID (e.g.,
C1234567890) or the channel name (e.g.,#general). The bot must be invited to the channel. \n - Message (required): The message content to send to the channel. \n
Output data points:
\n- \n
- messageTs: The timestamp/ID of the posted message. This can be used for threading or updating the message later. \n
- channelId: The channel ID where the message was posted. \n
Slack extension changelog
\nInitial release
\nInitial release of the Slack extension with the following action:
\n- \n
- Send Message to Channel: Send a message to a Slack channel from your care flow. \n
\n
title: Stedi\ndescription: Automate healthcare transactions like real-time eligibility checks and claims processing with APIs that support thousands of payers.
\n\n
Stedi
\nAutomate healthcare transactions like real-time eligibility checks and claims processing with APIs that support thousands of payers.
","changelog":"CHANGELOG
","actions":{"checkEligibility":{"key":"checkEligibility","title":"Check eligibility","description":"This is a dummy action that checks eligibility for a given request.","category":"Billing","fields":{"data":{"id":"data","label":"Data","description":"Paste example JSON here that mocks the data Stedi would return","type":"string","required":true}},"previewable":false,"dataPoints":{"data":{"key":"data","valueType":"string"}}}},"webhooks":[],"description":"Automate healthcare transactions like real-time eligibility checks and claims processing with APIs that support thousands of payers.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1753954684/Awell%20Extensions/skaoypelxrnkigpymjye.webp","title":"Stedi","category":"Billing","author":{"authorType":"Awell"},"settings":{}},{"key":"stripe","htmlDocs":"\n
title: Stripe
\ndescription: Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
\nStripe
\nStripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
\nExtension settings
\nFor the extension to function correctly, you must configure the following settings:
\n- \n
- Secret key (test and live mode) \n
- Publishable key (test and live mode) \n
- Mode (\"Test\" or \"Live\") \n
Stripe changelog
","actions":{"createSubscription":{"key":"createSubscription","title":"Create subscription","description":"Create a subscription in Stripe","category":"Billing","fields":{"customer":{"id":"customer","label":"Customer","description":"The identifier of the customer to subscribe","type":"string","required":true},"item":{"id":"item","label":"Item","description":"The ID of the price object","type":"string","required":true}},"previewable":false,"dataPoints":{"subscriptionId":{"key":"subscriptionId","valueType":"string"}}},"createCustomer":{"key":"createCustomer","title":"Create customer","description":"Create a customer in Stripe","category":"Billing","fields":{"email":{"id":"email","label":"Email","description":"Customer’s email address. It’s displayed alongside the customer in your dashboard and can be useful for searching and tracking.","type":"string","required":false},"name":{"id":"name","label":"Name","description":"The customer’s full name or business name.","type":"string","required":false}},"previewable":true,"dataPoints":{"customerId":{"key":"customerId","valueType":"string"}}},"embeddedCheckout":{"key":"embeddedCheckout","title":"Embedded checkout","description":"Embedded checkout in Awell Hosted Pages","category":"Billing","fields":{"mode":{"id":"mode","label":"Mode","description":"The mode of the checkout session which can be 'payment', 'setup', and 'subscription'","type":"string","required":true,"options":{"dropdownOptions":[{"label":"Payment","value":"payment"},{"label":"Setup","value":"setup"},{"label":"Subscription","value":"subscription"}]}},"item":{"id":"item","label":"Item","description":"The id of the item (price ID) the customer is purchasing","type":"string","required":true}},"previewable":false,"dataPoints":{"success":{"key":"success","valueType":"boolean"}},"options":{"stakeholders":{"label":"Stakeholder","mode":"single"}}}},"webhooks":[],"description":"Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1715008389/Awell%20Extensions/images_1.png","title":"Stripe (alpha)","category":"Billing","author":{"authorType":"Awell"},"settings":{"testModeSecretKey":{"key":"testModeSecretKey","label":"Test mode secret key","obfuscated":true,"required":true,"description":"This key is used to authenticate requests on your server when in test mode"},"testModePublishableKey":{"key":"testModePublishableKey","label":"Test mode publishable key","obfuscated":false,"required":true,"description":"This key is used for testing Embedded checkout in Awell Hosted Pages"},"liveModeSecretKey":{"key":"liveModeSecretKey","label":"Live mode secret key","obfuscated":true,"required":true,"description":"This key is used to authenticate requests on your server when in live mode"},"liveModePublishableKey":{"key":"liveModePublishableKey","label":"Live mode publishable key","obfuscated":false,"required":true,"description":"This key is used for testing Embedded checkout in Awell Hosted Pages"},"mode":{"key":"mode","label":"Mode","obfuscated":false,"required":true,"description":"\"Test\" or \"Live\", defaults to \"Test\". Make sure to have a secret key set for live mode when enabling it."},"hostedPagesEnvironmentVariable":{"key":"hostedPagesEnvironmentVariable","label":"Hosted Pages environment variable","obfuscated":false,"required":true,"description":"This will be removed once the extension is out of alpha mode. This needs to be configured by an Awell developer."}}},{"key":"talkDesk","htmlDocs":"\n
title: Talkdesk
\ndescription: Talkdesk is a cloud-based customer experience and contact center software company. It provides a platform that enables businesses to set up and manage their customer service and support operations.
\nTalkDesk
\nTalkdesk is a cloud-based customer experience and contact center software company. It provides a platform that enables businesses to set up and manage their customer service and support operations. Talkdesk offers a range of features and tools to streamline and enhance communication between businesses and their customers.
\nSetup
\nTo set up the extension, you'll need your Talkdesk account name along with a client ID and client secret. Please ensure that the credentials you provide are associated with the necessary permissions, or \"scopes,\" to run the extension:
\n- \n
- flows-interactions:start \n
Custom Actions
\nTrigger flow
\nEnables the initiation of a Talkdesk flow directly from an Awell careflow. This feature triggers an interaction using the most recent published version of a specific Studio flow. You'll need to supply the ID of the flow and the data (as a JSON object) that you want to input into the flow.
\nImportant: Please note that Talkdesk sets a restriction of up to two API requests per second (rps) for each account using their Flows API.
\nClick here to learn more about triggering flows via the Talkdesk API and here to read the API docs.
","changelog":"TalkDesk changelog
","actions":{"triggerFlow":{"key":"triggerFlow","title":"Trigger flow","description":"Trigger a flow in Talkdesk","category":"Communication","fields":{"flowId":{"id":"flowId","label":"Flow ID","description":"The ID of the flow you would like to trigger","type":"string","required":true},"autoComplete":{"id":"autoComplete","label":"Autocomplete","description":"If true, the activity will not wait for the flow to complete (default: false)","type":"boolean","required":false},"data":{"id":"data","label":"Data","description":"Data to be ingested when triggering the flow, including the `awell_activity_id` so the flow can perform the appropriate completeExtensionActivity callback.","type":"json","required":true}},"previewable":false,"dataPoints":{"interactionId":{"key":"interactionId","valueType":"string"},"flowVersionId":{"key":"flowVersionId","valueType":"string"},"call_start_time":{"key":"call_start_time","valueType":"date"},"call_end_time":{"key":"call_end_time","valueType":"date"},"call_duration_ms":{"key":"call_duration_ms","valueType":"number"},"call_status":{"key":"call_status","valueType":"string"},"disposition":{"key":"disposition","valueType":"string"},"agent":{"key":"agent","valueType":"string"}}}},"webhooks":[],"description":"Talkdesk is a cloud-based customer experience and contact center software company.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1689344292/Awell%20Extensions/talkdesk_logo.jpg","title":"Talkdesk","category":"Communication","author":{"authorType":"Awell"},"settings":{"talkDeskAccountName":{"key":"talkDeskAccountName","label":"Talkdesk account name","obfuscated":false,"description":"","required":true},"region":{"key":"region","label":"Region","obfuscated":false,"description":"US, EU, or Canada. Defaults to US.","required":false},"clientId":{"key":"clientId","label":"Client ID","obfuscated":false,"description":"The client ID for OAuth2 Password authentication.","required":true},"clientSecret":{"key":"clientSecret","label":"Client Secret","obfuscated":true,"description":"The client secret for OAuth2 Password authentication.","required":true}}},{"key":"textline","htmlDocs":"\n
title: TextLine
\ndescription: Textline's business texting software offers solutions for sales, marketing, customer service and beyond. Utilize the power of SMS to grow quickly.
\nTextLine
\nTextLine is a customer engagement platform used by hundreds of thousands of businesses and more than ten million developers worldwide to build unique, personalized experiences for their customers.
\nThey are known for democratizing channels like voice, text, chat, video, and email through APIs, making it easy for every organization to build meaningful interactions with customers on the channels they prefer.
\nExtension settings
\nIn order to set up this extension, you will need:
\n- \n
- A TextLine API key or auth token which can be found in the TextLine console. \n
- Your account SID which can be found in the TextLine console. \n
- A phone number to send the message from. This must be a TextLine phone number that you own. \n
Custom Actions
\nSend SMS
\nSend an SMS with TextLine to a recipient of your liking.
\nGet messages
\nThis action retrieves received messages. One can apply the phoneNumber filter to this action to display only received messages from that phoneNumber.\nOnly the last 30 messages are returned.
Set Contact Consent
\nFor HIPAA and Pro accounts setup with Contact Consent, this action can set contact's consent status. To do this, your account must have API import allowed and the user making the API request must have the \"Can manually set consent\" permission on for their role. You must then use the Contact's phone number and their consent status (true or false).
\nSimple Use Case
\nInitiating a Conversation: A user sends a message to \"Number A\", initiating a conversation.
\nReceiving a Response: \"Number A\" responds to the message, contributing to the ongoing conversation.
\nSearching Messages & Applying Filters: To focus on the responses from \"Number A\", `phoneNumber`` filter can be applied to only show received messages from \"Number A\" within the conversation. This allows users to easily review and manage responses from \"Number A\", without the clutter of other received messages.
","changelog":"TextLine changelog
\n2024-03-11
\n- \n
- Add option to set department ID when sending messages and when retrieving messages. Check official documentation here: https://textline.docs.apiary.io/#reference/conversations/phone-numbers/message-a-phone-number \n
2024-03-5
\n- \n
- Add capability to set contact consent status (https://textline.docs.apiary.io/#reference/customers/set-contact-consent/set-contact-consent) \n
- Add several fixes and tweaks to improve current actions \n
2024-02-26
\n- \n
- Add capability to search for messages using all the allowed filters provided by TextLine API. \n
- Add \"Send SMS\" action \n
\n
title: Text-Em-All
\ndescription: Text-Em-All is a texting and automated calling service that enables organizations to communicate with patients.
\nText-Em-All
\nText-Em-All is a texting and automated calling service that enables organizations to communicate with patients.
\nSupported Actions
\n- \n
- sendSMSBroadcast - Schedule SMS message to a specified user \n
- sendCallBroadcast - Schedule an Call message to a specified user \n
Webhooks
\nBroadcast Status Change
\nTriggered when the status of a call or text broadcast changes to one of the following states:
\n| Status | \nDescription | \n
|---|---|
created | \nA broadcast has been created on your Call-Em-All account. It may be scheduled to run in the future and it may not have all the information set up to run yet. | \n
ready | \nThe broadcast has all information necessary to run and is waiting for its start time. | \n
broadcasting | \nThe broadcast started to send out phone calls or text messages. | \n
completed | \nThe broadcast has finished sending out all phone calls or text messages. | \n
paused | \nThe broadcast has been paused and no calls or texts are going out. | \n
resumed | \nA paused broadcast resumes. | \n
canceled | \nThe broadcast was canceled. | \n
expired | \nThe window that was set up for the broadcast by the user was insufficient to send out all the calls or texts. The broadcast has been expired and some of the calls and texts are not delivered. | \n
Webhook includes:
\n- \n
- Broadcast ID \n
- Broadcast status \n
Setup
\nThe Text-Em-All extension requires the following settings to be configured:
\n| Setting name | \nRequired | \nDescription | \n
|---|---|---|
customerKey | \nYes | \nYour Text-Em-All customer key | \n
customerSecret | \nYes | \nYour Text-Em-All customer secret | \n
token | \nYes | \nYour Text-Em-All token | \n
baseUrl | \nYes | \nYour Text-Em-All base URL | \n
Find out more
\nFor detailed information about setting up webhooks, notification formats, and additional event types, please visit the Text-Em-All Webhooks documentation.
","changelog":"Text-em-all changelog
","actions":{"createSMSBroadcast":{"key":"createSMSBroadcast","title":"Send a new SMS broadcast","description":"Send a text message to a recipient. Returns the delivery result (sent, invalid_number, failed, etc.) for triage purposes.","category":"Communication","fields":{"broadcastName":{"id":"broadcastName","label":"Broadcast Name","type":"string","required":true,"description":"The name of the broadcast."},"phoneNumber":{"id":"phoneNumber","label":"Phone Number","type":"string","stringType":"phone","required":false,"description":"The primary phone number of the recipient. Must be a valid NANP phone number. If omitted, falls back to the patient mobile phone from their profile."},"firstName":{"id":"firstName","label":"First Name","type":"string","required":false,"description":"The first name of the contact. If omitted, falls back to the patient first name from their profile."},"lastName":{"id":"lastName","label":"Last Name","type":"string","required":false,"description":"The last name of the contact. If omitted, falls back to the patient last name from their profile."},"notes":{"id":"notes","label":"Notes","type":"string","required":false,"description":"Notes about the contact (e.g., \"Eligibility form from Awell\")."},"integrationData":{"id":"integrationData","label":"Integration Data","type":"string","required":false,"description":"Extra field for integration information."},"textMessage":{"id":"textMessage","label":"Text Message","type":"text","required":true,"description":"The text of the message for a text type broadcast. The max length is based on the setting in your account."},"textNumberID":{"id":"textNumberID","label":"Text Number ID","type":"numeric","required":false,"description":"The ID of the text number your messages will be sent from. If omitted, the default text number on your account will be used."},"startDate":{"id":"startDate","label":"Start Date","type":"date","required":false,"description":"The time the broadcast should start. Will default to start immediately. If provided must be a datetime as ISO 8601 string and time to send the message in UTC"},"checkCallingWindow":{"id":"checkCallingWindow","label":"Check Calling Window","type":"boolean","required":false,"description":"Whether to enforce the calling window restrictions. Defaults to false."}},"dataPoints":{"success":{"key":"success","valueType":"boolean"},"broadcastId":{"key":"broadcastId","valueType":"number"},"broadcastStatus":{"key":"broadcastStatus","valueType":"string"},"uriBroadcastDetails":{"key":"uriBroadcastDetails","valueType":"string"},"broadcastStatusCategory":{"key":"broadcastStatusCategory","valueType":"string"},"broadcastStartDate":{"key":"broadcastStartDate","valueType":"string"},"deliveryResult":{"key":"deliveryResult","valueType":"string"},"deliveryResultDetails":{"key":"deliveryResultDetails","valueType":"string"}},"previewable":true}},"webhooks":[{"key":"broadcastStatusChange","dataPoints":{"broadcastId":{"key":"broadcastId","valueType":"number"},"broadcastStatus":{"key":"broadcastStatus","valueType":"string"}}}],"description":"Send text messages to your patients.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/c_thumb,w_200,g_face/v1740592441/text-em-all-logo_ljty2t.png","category":"Communication","title":"Text-em-all","author":{"authorType":"Awell"},"settings":{"customerKey":{"label":"Customer Key","key":"customerKey","obfuscated":true,"required":true,"description":"Your Text-Em-All customer key."},"customerSecret":{"label":"Customer Secret","key":"customerSecret","obfuscated":true,"required":true,"description":"Your Text-Em-All customer secret."},"token":{"label":"Token","key":"token","obfuscated":true,"required":true,"description":"Your Text-Em-All token."}}},{"key":"transform","htmlDocs":"\n
title: Transform
\ndescription: Transform is an extension with utility functions that allows you to transform or parse data to a format of your liking
\nTransform
\nTransform is an extension on Awell's Marketplace with utility functions that allows you to transform data from one type to another. These functions are particularly useful e.g. when system A works with IDs that are numbers but system B works with IDs that are strings.
\nCustom Actions
\nParse number to text
\nTransform or parse a number to text (string).
\nParse text to number
\nTransform or parse text (string) to a number. Will return NaN if the input data is not an actual number.
\nParse date to unix timestamp
\nTransform or parse a date to a unix timestamp.
\nParse unix timestamp to unix date
\nTransform or parse a unix timestamp to a date.
\nParse number to text with dictionary
\nTransform or parse a number to a string using a dictionary. Useful for when you have numeric data points but want to map them to strings based on a dictionary. When the action is called with a number that does not have a corresponding mapping in the provided dictionary, it simply returns the number itself as a string.
\nThe dictionary should be structured in JSON format with string keys mapping to string values. Each key represents a number (as a string), and each value is the corresponding text representation.
\nExample:
\n{\n \"0\": \"Male\",\n \"1\": \"Female\",\n \"2\": \"Not known\",\n // ... other number mappings ...\n}\nGenerate dynamic URL
\nGenerate a dynamic URL based on a URL template with placeholder and a data point value.
\nurlTemplate https://your-url.com/{{placeholder}}\nvalue hello-world\noutcome https://your-url.com/hello-world\nFeet and inches to inches
\nConverts a measurement in feet and inches to just inches.
\nCombine date and time
\nCombines a reference date with a time string to create a complete datetime in UTC format. This action supports two input formats for the time string:
\n- \n
- Simple time format (HH:mm:ss): Combines the reference date with the specified time in ISO format (e.g., \"14:30:00\" not \"2PM\") \n
- Full datetime with timezone: Accepts ISO8601 datetime strings with timezone offsets and converts them to UTC \n
Examples:
\nExample 1 - Simple time combination:
\nReference date: 2025-09-13\nTime string: 17:45:00\nResult: 2025-09-13T17:45:00Z\nExample 2 - Reference date precedence with timezone-aware datetime:
\nReference date: 2025-09-01\nTime string: 2025-09-06T15:34:44+02:00\nResult: 2025-09-01T13:34:44Z (reference date takes precedence, time converted from +02:00 to UTC)\nExample 3 - Different timezone offset:
\nReference date: 2025-09-06\nTime string: 2025-09-06T10:30:00-05:00\nResult: 2025-09-06T15:30:00Z (converted from -05:00 to UTC)\nThis action is particularly useful for scheduling systems like Bland API where you need to combine dates and times from different sources, or when working with timezone-aware scheduling data that needs to be normalized to UTC.
","changelog":"Transform changelog
\nJune 2024
\n- \n
- Added \"Feet and inches to inches\" action \n
March 2024
\n- \n
- Added \"Generate dynamic URL\" action \n
January 2024
\n- \n
- Added \"Parse number to text with dictionary\" action \n
\n
title: Twilio
\ndescription: Twilio is a customer engagement platform used by hundreds of thousands of businesses and more than ten million developers worldwide to build unique, personalized experiences for their customers.
\nTwilio
\nTwilio is a customer engagement platform used by hundreds of thousands of businesses and more than ten million developers worldwide to build unique, personalized experiences for their customers.
\nThey are known for democratizing channels like voice, text, chat, video, and email through APIs, making it easy for every organization to build meaningful interactions with customers on the channels they prefer.
\nExtension settings
\nIn order to set up this extension, you will need:
\n- \n
- A Twilio API key or auth token which can be found in the Twilio console. \n
- Your account SID which can be found in the Twilio console. \n
- A phone number to send the message from. This must be a Twilio phone number that you own. \n
User consent
\nThe extension has some built-in mechanisms to enforce compliance with Twilio's messaging policy.
\nOpt-out
\nBy default, every text message will be appended with standard opt-out language (\"Reply STOP to unsubscribe.\"). You can specify custom opt-out language within the settings of the extension but make sure the opt-out keywords used are supported. STOP, UNSTOP, UNSUBSCRIBE or CANCEL are the default opt-out keywords supported but Twilio also supports defining custom stop keywords.
\nIf you don't want to append opt-out language to your text messages, set the \"Add opt-out language\" setting to \"Off\".
\nFor more information, please visit the Twilio docs.
\nSending text messages to recipients that opted out
\nIf you attempt to send a text message to a recipient who has opted out, the message will fail to be delivered and the action will be marked as failed. This is the default behavior of Twilio's API, which prevents sending texts to anyone who has chosen to opt out.
\nCustom Actions
\nSend SMS
\nSend an SMS with Twilio to a recipient of your liking.
\nGet messages
\nGet a list of text messages matching the given criteria. Only the last 50 messages are returned.
\nSend SMS during working hours
\nThis action allows for the scheduling of SMS messages to be sent within the \"daily operational hours\" of 9 AM to 5 PM. It ensures that text messages are dispatched at appropriate times during the day, avoiding early morning or late-night disturbances to recipients.
\nHere's how it works:
\n- \n
- If the action is activate during business hours (9 AM to 5 PM), the SMS is sent immediately. \n
- If activated before 9 AM, the SMS is scheduled to be sent at 9 AM on the same day. \n
- If activated after 5 PM, the SMS is scheduled to be sent at 9 AM the following day. \n
This setup ensures that all messages reach your respondents during reasonable daytime hours, enhancing the likelihood of a timely and considerate communication. It's important to mention that messages will still be dispatched over the weekend, but they will adhere to the \"business hours\" schedule of 9 AM to 5 PM.
\nNote that scheduling messages with Twilio is only possible if you send text messages using a MessagingServiceSid.
","changelog":"Twilio changelog
\nv2 2024-02-22
\n- \n
- Add capability to search for messages using all the allowed filters provided by Twilio API. Check here: https://www.twilio.com/docs/messaging/api/message-resource#read-multiple-message-resources \n
v2 2023-06-23
\nFull description: https://github.com/awell-health/awell-extensions/issues/157
\n- \n
- \"Send SMS\" action \n
- Change label from \"Send SMS\" to \"Send SMS (with from number)\" \n
- Throw error when \"From\" number in both settings and in fields is not provided \n
- Add new action \"Send SMS (with Messaging Service)\" \n
v2
\nCompared to v1 (pre-beta release), the extension only has one custom action \"Send SMS\" instead of two. The Custom Action allows for:
\n- \n
- Sending a text message to a recipient (phone number) stored in a data point, including patient profile data points. \n
- Sending a text message to a fixed recipient (phone number). \n
\n
title: WestFax
\ndescription: WestFax is a leading provider of HIPAA Compliant Cloud Fax / Fax to Email, Print to Fax
\nWestFax
\nWestFax is a cloud-based faxing service that offers a variety of features, including:
\n- \n
- Secure faxing: WestFax uses end-to-end encryption to protect your documents from unauthorized access. \n
- HIPAA compliance: WestFax is HIPAA compliant, so you can be sure that your medical records are safe. \n
- Integration with other applications: WestFax can be integrated with your existing email, CRM, and other applications. \n
- Mobile app: You can send and receive faxes from your mobile device with the WestFax mobile app. \n
- Paperless faxing: WestFax can store your faxes in the cloud, so you can access them from anywhere. \n
WestFax x Awell
\nThis extension allows you to let a stakeholder (eg: a patient) send a fax as part of a care flow.
\nExtension settings
\nIn order to set up this extension, you will need to provide a WestFax Username and Password. You will need as well to provide the ProductId when setting up the action - check how here.
\nActions
\nGet Fax document
\nRetrieve a fax document using a fax ID, sometimes also referred to as a job ID.
\nWebhooks
\nFax received
\nTrigger a care flow when a fax is received. Currently only works together with https://github.com/awell-health/westfax-webhook-handler
","changelog":"WestFax changelog
\nFebruary 2024
\n- \n
- Initial action to send an fax to an email \n
\n
title: Workramp
\ndescription: WorkRamp is the all-in-one LMS platform for employees, customers, and partners.
\nWorkramp
\nWorkramp is a learning management platform helping to upskill employees and educate partners and customers.
\nExtension settings
\nThere are no extension settings (e.g. API keys) to set. Simply enable the extension and then utilize the EventPayload webhook to subscribe to events.
\nWebhooks
\nEventPayload
\nListens to an event and starts a care flow, using the user.id field as a unique patient identifier.
To learn more about webhooks, visit their developer site.
","changelog":"Workramp changelog
\n2024-08-28
\nCreated the extension.
","actions":{},"webhooks":[{"key":"eventWebhook","dataPoints":{"eventType":{"key":"eventType","valueType":"string"}}}],"description":"An LMS platform. The system identifier used is https://www.workramp.com/","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1724917358/Awell%20Extensions/workramp_logo.jpg","title":"Workramp","category":"Content & Files","author":{"authorType":"Awell"},"settings":{}},{"key":"zendeskSell","htmlDocs":"\n
title: Zendesk Sell
\ndescription: Zendesk Sell is a customer service and support platform that provides a suite of tools and software for businesses to manage their customer interactions.
\nZendesk Sell
\nZendesk Sell is a customer service and support platform that provides a suite of tools and software for businesses to manage their customer interactions. It offers a range of customer service solutions, including help desk ticketing systems, customer support and engagement, and self-service options. Zendesk is designed to help companies streamline their customer support processes, improve communication with their customers, and resolve issues more efficiently.
\nExtension settings
\nIn order to set up this extension, you will to authenticate with the Sell API and need an API token. You can visit Zendesk Sales CRM dashboard and go to Settings > Integration > OAuth to enable and create an API token. Read more about how to get an access token for the Sell API here.
\nCustom Actions
\nCreate task
\nCreates a new task. You can create either a floating task or create a related task and associate it with one of the resource types: Leads, Contacts, Deals.
\nComplete task
\nMarks a task as completed.
","changelog":"Zendesk changelog
","actions":{"createTask":{"key":"createTask","title":"Create task","description":"Creates a new task in Zendesk","category":"Customer Support","fields":{"content":{"label":"Content","id":"content","type":"string","stringType":"text","required":true,"description":"Content of the task."},"dueDate":{"label":"Due date","id":"dueDate","type":"date","required":false,"description":""},"ownerId":{"label":"Owner ID","id":"ownerId","type":"numeric","required":false,"description":"Unique identifier of the user the task is assigned to, defaults to the user who created the task"},"resourceType":{"label":"Resource type","id":"resourceType","type":"string","required":false,"description":"Name of the resource type the task is attached to. Possible values: \"lead\", \"contact\", \"deal\"."},"resourceId":{"label":"Resource ID","id":"resourceId","type":"numeric","required":false,"description":"Unique identifier of the resource the task is attached to."},"completed":{"label":"Completed?","id":"completed","type":"boolean","required":false,"description":"Indicator of whether the task is completed or not."},"remindAt":{"label":"Remind at","id":"remindAt","type":"date","required":false,"description":"The date at which Zendesk should send you a reminder about the task."}},"dataPoints":{"taskId":{"key":"taskId","valueType":"number"}},"previewable":true},"completeTask":{"key":"completeTask","title":"Complete a task","description":"Completes a task in Zendesk","category":"Customer Support","fields":{"taskId":{"label":"Task ID","id":"taskId","type":"numeric","required":true,"description":"The ID of the task to complete in Zendesk"}},"previewable":true}},"webhooks":[],"description":"Zendesk Sell is a customer service and support platform that provides a suite of tools and software for businesses to manage their customer interactions.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1697013804/Awell%20Extensions/ezgif.com-webp-to-png.png","title":"Zendesk Sell","category":"Customer Support","author":{"authorType":"Awell"},"settings":{"salesApiToken":{"label":"Sales API token","key":"salesApiToken","obfuscated":true,"required":true,"description":"Visit Zendesk Sales CRM dashboard and go to Settings > Integration > OAuth to enable and create an API token"}}},{"key":"zendesk","htmlDocs":"Zendesk Support
\nZendesk Support is a customer service platform that provides ticketing, knowledge base, and customer communication tools.
\nExtension settings
\nTo set up this extension, you will need to provide the following:
\n- \n
- Zendesk Subdomain: your Zendesk subdomain (e.g., \"company\" for company.zendesk.com) \n
- User Email: your Zendesk user email address \n
- API Token: your Zendesk API token \n
You can generate an API token in your Zendesk admin settings under API > Zendesk API.
\nActions
\nCreate Ticket
\nCreates a new support ticket in Zendesk with the specified details.
\nRequired fields:
\n- \n
- Subject: The subject line of the ticket \n
- Comment: The initial comment/description for the ticket \n
Optional fields:
\n- \n
- Group ID: The ID of the group to assign the ticket to \n
- Priority: The priority level (urgent, high, normal, or low) \n
- External ID: An external identifier to link this ticket to your system \n
- Tag: A tag to add to the ticket \n
Returns:
\n- \n
- Ticket ID: The unique identifier of the created ticket \n
- Ticket URL: Direct link to the ticket in Zendesk agent interface \n
Delete Ticket
\nDeletes a support ticket in Zendesk. This action permanently removes the ticket from your Zendesk instance.
\nRequired fields:
\n- \n
- Ticket ID: The unique identifier of the ticket to delete \n
Note: This action cannot be undone. Deleted tickets are permanently removed from Zendesk.
","changelog":"Changelog
\nAll notable changes to this project will be documented in this file.
\n[1.0.0] - 2025-01-10
\nAdded
\n- \n
- Initial release of Zendesk Support extension \n
- Create Ticket action with OAuth authentication \n
- Support for all major ticket fields: subject, comment, group_id, priority, external_id, tags \n
\n
title: Zoom
\ndescription: Zoom is a communications platform that allows users to connect with video, audio, phone, and chat.
\nZoom
\nZoom is a communications platform that allows users to connect with video, audio, phone, and chat.
\nExtension settings
\nTo set up this extension, you will need to provide the following:
\n- \n
- Account ID: your Zoom account ID, found on the Server to Server app build page. \n
- Client ID: the client ID of the OAuth app you created in Zoom \n
- Client secret: the client secret of the OAuth app you created in Zoom \n
You'll have to set up a Server-to-Server OAuth app in Zoom to provision a client ID and secret.
\nActions
\nSend SMS
\nSend an SMS to a recipient.
\nEnsure your Server-to-Server OAuth app has the following scopes set:
\n- \n
- Scopes:
contact_center_sms:write:admin\n - Granular Scopes:
contact_center:write:sms:admin\n
Result codes
\nOn completion, the action returns a code data point indicating the outcome:
- \n
- SUCCESS: SMS was sent successfully. \n
- INVALID_CONSUMER_NUMBER_FORMAT: Invalid consumer number; E.164 format is required. \n
- CONTACT_CENTER_NUMBER_USED: Zoom Contact Center numbers cannot be used as consumer numbers. \n
- CONSUMER_NOT_OPTED_IN: The consumer number you have messaged has not opted in. \n
- CONSUMER_OPTED_OUT: The consumer number has opted out of receiving SMS from this Zoom Contact Center number. \n
- CONSUMER_BLOCK_LISTED: The consumer number is block-listed by your Zoom Contact Center administrator. \n
- INTERNATIONAL_SMS_NOT_SUPPORTED: International messaging is not supported on this account. \n
- BODY_TOO_LONG: Validation error — body exceeds 500 characters. \n
CHANGELOG
","actions":{"sendSms":{"key":"sendSms","title":"Send SMS","description":"Send an SMS","category":"Communication","fields":{"contactCenterNumber":{"id":"contactCenterNumber","label":"Contact center number","description":"This must be an SMS capable phone number allocated to Zoom Contact Center within your account.","type":"string","stringType":"phone","required":true},"to":{"id":"to","label":"To","description":"The phone number of the person receiving the SMS.","type":"string","stringType":"phone","required":true},"body":{"id":"body","label":"Body","description":"The content that needs to be sent as an SMS. Maximum length is 500 characters.","type":"text","required":true}},"previewable":true,"dataPoints":{"messageId":{"key":"messageId","valueType":"string"},"success":{"key":"success","valueType":"boolean"},"code":{"key":"code","valueType":"string"}}}},"webhooks":[],"description":"Zoom is a communications platform that allows users to connect with video, audio, phone, and chat.","icon_url":"https://res.cloudinary.com/da7x4rzl4/image/upload/v1746027815/Awell%20Extensions/zoom.svg","title":"Zoom","category":"Communication","author":{"authorType":"Awell"},"settings":{"accountId":{"key":"accountId","label":"Account ID","obfuscated":false,"description":"The account ID of your Zoom account.","required":true},"clientId":{"key":"clientId","label":"Client ID","obfuscated":false,"description":"The client ID issued by the Server-to-Server OAuth app.","required":true},"clientSecret":{"key":"clientSecret","label":"Client Secret","obfuscated":true,"description":"The client secret issued by the Server-to-Server OAuth app.","required":true}}},{"key":"srfax","htmlDocs":"SRFax
\nRetrieve fax documents from SRFax and extract text via LandingAI OCR.
\nExtension settings
\n- \n
- Account ID (required) \n
- Password (required) \n
- Base URL (optional, default: https://www.srfax.com/SRF_SecWebSvc.php) \n
Action: Get fax document with OCR
\n- \n
- Inputs \n
- faxId (string, required): SRFax FaxDetailsID (number after the
|) or full FileName \n - ocrProvider:
awell-landing-ai\n - ocrProviderApiKey (string, required) \n
- fieldsSchema (JSON, optional) \n
- Outputs \n
- markdown (string) \n
- chunks (json) \n
- extractedDataBasedOnSchema (json) \n
- extractedMetadata (json) \n
- direction (string) \n
- date (date) \n
- status (string) \n
- format (string) \n
- pageCount (number) \n
Changelog
\nAll notable changes to the SRFax extension will be documented in this file.
\n1.0.0
\n- \n
- Initial release: getFaxDocumentWithOCR action using SRFax Retrieve_Fax and LandingAI OCR (base64 mode). \n