Intervengine Application API
A RESTful API for the Intervengine application.
®Intervengine recreates personalised coaching experiences through engaging digital journeys, achieving behaviour change at a fraction of the cost of traditional coaching. Improve the health and wellbeing of your customers, patients, employees or members with our behaviour change tools, evidence-based content library and self-service journey builder.
Create and manage your health and wellness programmes and configure adaptive digital journeys that can sense and respond to each person’s unique goals and coaching needs.
Changes from 1.3.2
The ActivityValue schema has been updated. MeasureTypeContent has now been integrated into ActivityValue, allowing you to create questionnaires that include a mix of both questions and content.Please refer to the ActivityValue and MeasureTypeContent schema documentation for more details.
- MeasureTypeContent has been embedded in ActivityValue. This represents a single page content
- Removed the redundant valueDataType field in ActivityValue schema. Use measureDataType instead.
- Removed the experimental contentId field in ActivityValue schema. Use the embedded content instead.
Changes from 1.3.0
Request parameters changed at api/v1/participants/{user_id}/enrolments- Added 'interventionStartFrom' and 'interventionEndAt' fields to a journey enrolment parameter. This will be used to set the preferred intervention start and end hours for the participant.
- Deprecated preferredReminderHour and preferredReminderMin fields from the journey enrolment parameter.
Changes from 1.2.x
Deprecated Endpoints- POST /admin/participants (User /participants to create a new participant instead)
- GET /participants/{user_id}/activity_plans/{id}/data
- GET /participants/{user_id}/activity_plans/all/latest
- PUT /participants/{user_id}/survey_responses
- PUT /participants/{user_id}/activity_responses (Use PUT /participants/{user_id}/activity_plan_cards/{id}/responses instead)
- PUT /participants/{user_id}/responses/undo Use (DELETE /participants/{user_id}/activity_plan_cards/{id}/responses instead)
New Endpoints The following new endpoints have been added. Please refer to the API documentation for more details
- GET /participants/{user_id}/chat_sessions/{id}
- POST /participants/{user_id}/chat_sessions/search
- POST /participants/{user_id}/chat_messages/search
- POST /participants/{user_id}/chat_messages
- POST /participants/{user_id}/chat_unread_messages/search
- 'participantTags'' field has changed to 'tags'
- 'participantExtras' field has changed to 'extras'
- 'participantGroups' field has changed to 'groups'
Changes in PATCH /participants/{user_id}/profile_photo endpoint
'file' field has changed to 'filename' by default. This can be changed by providing 'name' field to change the name of the form file field if required
Authentication
- API Key: api_key
- HTTP: Bearer Auth
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-API-Key |
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT |
Terms of Service
https://intervengine.com/termsLicense
Proprietary