Deep linking to content and features

Created by Logan Byrd, Modified on Fri, Mar 13 at 2:11 PM by Toby Alfaro

The Avidon 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 Avidon SSO endpoint, include a form parameter called RelayState. The RelayState supports the following values:


Features



Feature



RelayState Value



Trackers



Feature-Trackers



Personal Journal



Feature-JournalTool



Content Library Home Page



Feature-ContentLibrary




Courses


You can link to specific courses including both custom and Avidon system 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. Individual Custom Course ID’s are available when editing a course in the admin. To find the course ID (also known as a UUID), navigate to the course editor in the admin portal. The ID appears at the end of the URL after the final slash when you’re viewing or editing a specific course. For example:


RelayState=Course-8e262e17-6225-4eaa-a925-9a7823d63675


NOTE: The list of Avidon system course IDs is too voluminous to list everything here. A partial list for courses introduced through April 2025 is below.


To export a complete up-to-date list of Course ID's for a portal:

  • Log in to Avidon's admin site
  • Click Settings then Portal Management
  • Select any portal and navigate to that portal's Courses page
  • Right-click the page and click your preferred export option




Avidon Courses


CourseRelayState Value
Quitting Tobacco and Nicotine
Course-fc716aea-9f7a-494b-bb7c-3ebfd4d46103
Eating Healthy, Living Lean
Course-fd51e97e-5bdf-481b-8db0-b28c08311dd9
Controlling Alcohol
Course-785f250c-9619-41eb-b5fd-98236ba76a8b
Managing Stress, Building Resiliency
Course-6a3bf43d-e857-4caf-bc0d-6005dae6c581
Managing Diabetes
Course-a164f3f1-e8ab-43ee-9155-38d36082ef3a
Sleeping Soundly
Course-da6764ee-1b32-4a33-a807-cd997e6ac90c
Living Substance-Free
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
HydrationCourse-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
The Basics of Blood Pressure
Course-1bef890a-881f-4fd1-9679-d0c5bbacc686
Deskercise (Avoid the Perils of Prolonged Sitting)
Course-8fcadcf5-f72e-49f5-a1be-bd8e8aa899f3
Returning to the Workplace
Course-2e413eab-9236-47f7-aa49-c6619668443c
Better Mornings, Better Days
Course-7e514fab-46f8-4b78-91dc-220113c3a79d
Cut the Ultra-Processed Foods
Course-91afcdb7-dcf6-4b04-90d4-4bde34436aa3
From Couch to Active
Course-18b32201-b81a-417f-8b80-fa6604c888cf
Discover the Potential of Intermittent Fasting
Course-29700352-2586-4668-a3c7-4fa4aa7f0ac0
Short & Effective Workouts
Course-9c2246a0-c93d-4946-9a96-3056d3bde933
The Incredible Power of Gratitude
Course-d425905d-76ee-4cd7-b1a6-e50b225d0a8a
How to Read "Nutrition Facts" Labels
Course-40f7e64f-b519-468f-983d-f0d5c5424b25
Rebooting Real Life: A Guide to Digital Balance
Course-6c8faeec-4197-46d4-8d61-5b08a68144cd
Getting the Most from Your Gym Membership
Course-7f89489a-5863-49aa-83c9-875740692988
Shining a Light on Skin Health and the SunCourse-d9a21d19-0424-457e-8d1e-66df6a216031
A Shift Worker's Guide to Health and SanityCourse-308a9bda-51ae-4c25-a292-f0eb44cac341


 


Course Catalog


You can deep-link to the course catalog page:


RelayState=CourseCatalog-



 


Content Library Section


RelayState value format:        ContentSection-<ID>




Content Library Section



ID


Healthy Eating & Hydration
be859525-1c03-411e-be57-2a20bb114061
Exercise & Fitnessfb7b71dd-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 Programs


You can link to specific group programs configured for your portal.


RelayState value format:      GroupProgram-<ID>


Use the prefix "GroupProgram-" and replace <ID> with the ID of the actual group program you want to deep-link to.  Group Program ID’s are available when viewing or editing the group program settings in the group program editor.


For example:


RelayState=GroupProgram-8e262e17-6225-4eaa-a925-9a7823d63675



Habit Builders


You can link to a specific Habit Builder.


RelayState value format:      habit-builder-<ID>


Use the prefix "habit-builder -" and replace <ID> with the ID of the actual Habit Builder you want to deep-link to.  Habit Builder ID’s are available when viewing or editing the program settings in the program editor.


For example:


RelayState=habit-builder-8e262e17-6225-4eaa-a925-9a7823d63675


Avidon Habit Builders

Habit BuilderRelayState Value
Activate—7 Days of Motion!
RelayState=habit-builder-0317e385-f738-4081-8d02-6998b238fbe6
Easing into Exercise
RelayState=habit-builder-f3fc626b-47cc-436a-852c-f12054eafc71
Kickstart! Healthy Habits Reset
RelayState=habit-builder-62292b2e-73d4-4391-9a64-fca7773eca0c
Pump Up the Beat: Building Heart Healthy Habits
RelayState=habit-builder-ed86865d-6aed-4651-8c66-540af92d45b7
Rethink the Drink: Alcohol Cutback Habit Builder
RelayState=habit-builder-e98a7064-de84-41f3-ae9e-45c8ddbe92a0
Taming the Worry Wart: Your Anti-Anxiety Toolkit
RelayState=habit-builder-f99f59fd-ec61-4417-ab1d-7a82e31123ff
The Caffeine Cutback Experiment
RelayState=habit-builder-20477fd8-5498-43ea-aed4-8dcf7c437736
The Creativity Builder: Unboxing Your Perspective
RelayState=habit-builder-44b89529-b93c-4d54-8fc6-561e606a6f83
The Sleep Reset: Rhythm & Snooze
RelayState=habit-builder-f8c3ba68-1ca4-4c04-ba72-73208ba7e650


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

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article