The Engagement Rx system supports the ability to deep-link to various parts of the system during the Single Sign-On (SSO) process. This is facilitated via the SAML 2.0 RelayState parameter.
When POSTing a SAML Response to your Engagement Rx SSO endpoint, include a form parameter called RelayState. The RelayState supports the following values:
Features
Feature | RelayState Value |
Trackers | Feature-Trackers |
Body Mass (BMI) Calculator | Feature-BmiCalculator |
Calorie Tracker | Feature-CalorieCalculatorTool |
Personal Journal | Feature-JournalTool |
Content Library Home Page | Feature-ContentLibrary |
Courses
You can link to specific courses including both custom and included Engagement Rx courses using the following format:
RelayState value format: Course-<ID>
Use the prefix "Course-" and replace <ID> with the ID of the actual course you want to deep-link to. Custom Course ID’s are available when editing a course in the admin. For example:
RelayState=Course-8e262e17-6225-4eaa-a925-9a7823d63675
Below is the list of RelayState values for all of the Engagement Rx courses:
Course | RelayState Value |
Quitting Tobacco and Nicotine (LivinFree) | Course-fc716aea-9f7a-494b-bb7c-3ebfd4d46103 |
Eating Healthy, Living Lean (LivingLean) | Course-fd51e97e-5bdf-481b-8db0-b28c08311dd9 |
Controlling Alcohol (LivingSmart) | Course-785f250c-9619-41eb-b5fd-98236ba76a8b |
Getting Active (LivingFit) | Course-c458ca0e-8a5f-4c49-a63a-e5267bb93f0f |
Managing Stress, Building Resiliency (LivingEasy) | Course-6a3bf43d-e857-4caf-bc0d-6005dae6c581 |
Managing Diabetes (LivingWell) | Course-a164f3f1-e8ab-43ee-9155-38d36082ef3a |
Sleeping Soundly (LivingWellRested) | Course-da6764ee-1b32-4a33-a807-cd997e6ac90c |
Living Substance-Free (LivingClear) | Course-e2101fcb-0dfb-4a68-8570-0746a0a0c4e6 |
Nutrition | Course-2db8b684-5087-480f-8449-f9efb829f934 |
Healthy Weight | Course-c7cf1bab-ae54-42e1-b472-f0859b24527e |
Stress 101 | Course-47e484c0-abb6-4a83-b5b8-caafd7119469 |
Advanced Stress Management | Course-05fdbd42-a289-448f-bbb4-c4b622863c80 |
Stress Management for Healthcare Workers | Course-ddfa8b82-239a-46a9-a401-00fbda4e93a1 |
| Financial Wellness 101 | Course-c1ef65d3-89c6-4626-bc0c-6eff28e44b2c |
Habit Creation and the Brain | Course-efd1e4c4-f7a1-4f5d-8b5f-fc01f14e063d |
Retraining the Brain and Taking Control | Course-c31aa04e-34dd-4fdd-b1ae-90400f3eec1a |
Carrying New Healthier Lifestyles into the Future | Course-89c0ca30-0f8a-45bd-b64e-b47ebeaf0d6d |
Building Confidence, Commitment, and Motivation | Course-27257cd9-6cab-45e4-b836-2b0af146ad8e |
Finding Clarity in Vision | Course-4362b7e6-25a4-496c-87d8-da60b20864a8 |
Self-Talk, Conscious Choice, and Mindfulness | Course-e6a5e2af-ca8f-452e-b574-6aa843ff4dbb |
The Realities of Choice | Course-3bb9d5d5-47df-40a7-bc77-a501a899bd87 |
Retraining the Brain and Redefining Discomfort | Course-80bde6d9-b76f-4c26-9d93-b44619f5b7b0 |
| Hydration | Course-0083b839-8a4b-4b96-8493-8420f9fe259b |
Preparing Mentally for Weight Loss Medication | Course-f446ffa8-03c1-4008-8c0d-b70951b35e95 |
Sustained Results with Weight Loss Medication | Course-64e7d5bd-64e2-4add-b344-8b2a774a41dc |
Course Catalog
You can deep-link to the course catalog page and alternately filter which courses display on the page based on a list of keywords associated with the courses.
If no keywords are specified, the user will get redirected to the course catalog page with no filter applied. In other words, all courses enabled for the portal will display on the page.
RelayState value format: CourseCatalog-<keywords>
keywords is a comma delimited list and only courses that have ALL of the keywords will display.
Examples - Show all courses:
RelayState=CourseCatalog-
Example #2 - Show all courses that have the keyword "stress"
RelayState=CourseCatalog-stress
Example #3 - Show all courses that have both keywords "weight" AND "exercise"
RelayState=CourseCatalog-weight,exercise
Content Library Section
RelayState value format: ContentSection-<ID>
Content Library Section | ID |
Healthy Eating & Hydration | be859525-1c03-411e-be57-2a20bb114061 |
Exercise & Fitness | fb7b71dd-5695-4c5d-985e-f0bc62ae022f |
Healthy Weight | 3bc64e97-5ec2-48d3-92ac-94e0bb5c28fa |
Lifestyle | bb63f341-85be-4752-9896-0176f0942617 |
Mental & Psychological Wellness | d22e0b0c-ffba-45db-b657-24d7d7e51e4d |
General Health | a837164e-dfb6-453a-98fd-a6de26137330 |
Content
You can link to specific micro content (videos, articles, etc.) in the content library.
RelayState value format: Content-<ID>
Use the prefix "Content-" and replace <ID> with the ID of the actual content you want to deep-link to. Content ID’s are available when previewing content in the admin. For example:
RelayState=Content-8e262e17-6225-4eaa-a925-9a7823d63675
Flows
You can link to specific flows configured for your portal.
RelayState value format: Flow-<ID>
Use the prefix "Flow-" and replace <ID> with the ID of the actual flow you want to deep-link to. Flow ID’s are available when viewing or editing the flow settings in the flow admin.
For example:
RelayState=Flow-8e262e17-6225-4eaa-a925-9a7823d63675
Page Builder Pages
You can link to specific pages configured for your portal.
RelayState value format: Page-<ID>
Use the prefix "Page-" and replace <ID> with the ID of the actual page you want to deep-link to. Page ID’s are available when viewing or editing the page settings in the page builder editor.
For example:
RelayState=Page-8e262e17-6225-4eaa-a925-9a7823d63675
Challenges
You can link to specific challenges configured for your portal.
RelayState value format: Challenge-<ID>
Use the prefix "Challenge-" and replace <ID> with the ID of the actual challenge you want to deep-link to. Challenge ID’s are available when viewing or editing the challenge settings in the challenge editor.
For example:
RelayState=Challenge-8e262e17-6225-4eaa-a925-9a7823d63675
Group Coaching Programs
You can link to specific group coaching programs configured for your portal.
RelayState value format: GroupCoaching-<ID>
Use the prefix "GroupCoaching-" and replace <ID> with the ID of the actual group coaching program you want to deep-link to. Group Coaching Program ID’s are available when viewing or editing the group coaching program settings in the group coaching program editor.
For example:
RelayState=GroupCoaching-8e262e17-6225-4eaa-a925-9a7823d63675
Care Paths
You can link to specific care paths configured for your portal.
RelayState value format: CarePath-<ID>
Use the prefix "CarePath-" and replace <ID> with the ID of the actual care path you want to deep-link to. Care Path ID’s are available when viewing or editing the care path settings in the care path editor.
For example:
RelayState=CarePath-8e262e17-6225-4eaa-a925-9a7823d63675
Message Center
You can link to the message center or to a specific message in the center.
To link to the Message Center:
RelayState value format: messaging-
You can link to a specific message in the message center by adding the message ID:
RelayState value format: messaging-<messagingId>
For example:
RelayState=messaging-a9fe11dc-d207-4049-b89a-6d16d9e24a41
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article