Overview
The Redirect Card allows you to send respondents to an external website or application during or at the end of a chat. It supports passing respondent data through URL parameters and can capture additional data when respondents return to the chat (for mid-chat redirects).
There are two ways to configure a redirect:
Redirect out and end chat – Redirects the respondent and ends the chat.
Redirect out and return to chat – Redirects the respondent mid-chat and resumes the chat when they return.
1. Redirect Out and End Chat
The Redirect out and end chat option allows you to send respondents to an external website after they complete the chat.
How It Works
When this option is selected, respondents will be redirected to the specified URL at the end of the chat. You can pass additional respondent information (such as profile attributes, responses, or variables) to the external system by appending them as URL parameters. All parameter values are encoded using encodeURIComponent to ensure safe and reliable data transfer.
You can also enable Auto-Redirect, which will automatically redirect respondents without needing them to click a button.
Configuration Steps
Add a Redirect Card at the end of your chat flow.
In Redirect Settings, select Redirect out and end chat.
Provide a valid Redirect URL.
(Optional) Define URL Variables to pass respondent data as query parameters.
(Optional) Enable Auto-Redirect if you want the redirect to happen automatically.
ℹ️ Note: Ensure you have the correct parameter requirements from the external party so the data is passed in the expected format.
2. Redirect Out and Return to Chat
The Redirect out and return to chat option allows you to redirect respondents to an external application mid-chat. It pauses the chat for the respondent and they are able to resume when they return.
How It Works
When this option is enabled, respondents will be redirected mid-chat to complete an external activity. You can append respondent data to the redirect URL and define Input Variables to capture any additional information from the Return URL when the respondent returns. All parameter values are encoded using encodeURIComponent.
Once the external activity is complete, the external activity has to direct the respondent back to the chat. The respondent resumes the chat from where they had left.
Configuration Steps
Add a Redirect Card in your chat flow.
In Redirect Settings, select Redirect out and return to chat.
Provide a valid Redirect URL (HTTPS only). A return token is automatically appended to this URL. This token is required for Rival Platform to match the respondent to their chat session when they return.
(Optional) You can configure the label for the return token to align with what the external activity is expecting.
(Optional) Define URL Variables to pass respondent data.
Return URL is automatically generated with the return token appended. The Rival platform expects the return token to always be included in the format
return_token. If the external activity does not correctly append this token to the Return URL, the redirect back to the chat will fail.(Optional) You can append the Return URL to Redirect URL if the external activity prefers it in this format.
(Optional) Configure Input Variables to capture information from the Return URL.
(Optional) Enable Auto-Redirect if you want the redirect to happen automatically.
Additional Notes
Valid URLs: Only HTTPS URLs are supported in Redirect Card settings.
Data Security: Ensure sensitive data is not passed in query parameters without appropriate consent and compliance.
External System Requirements: Always confirm URL parameter structure and expected inputs with the external party you are redirecting to.