Skip to content

Update authentication.md 'Engage' product name is replaced with 'RingCX' #237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 29, 2024
Merged

Update authentication.md 'Engage' product name is replaced with 'RingCX' #237

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/sdks/survey-sdk/authentication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,27 @@ From a technical standpoint, a Survey SDK bridge is an HTTP endpoint that accept

## Request Authentication

Along with the requests to fetch the survey configuration and the responses, Engage Digital will also send a specific `X-SDK-SECRET` header containing the survey's **secret key** (see [Quick Start](../quick-start#survey-creation-in-engage-digital)) to allow you to make sure that the request actually comes from Engage Digital.
Along with the requests to fetch the survey configuration and the responses, RingCX Digital will also send a specific `X-SDK-SECRET` header containing the survey's **secret key** (see [Quick Start](../quick-start#survey-creation-in-engage-digital)) to allow you to make sure that the request actually comes from RingCX Digital.

!!! note
Please note that the `X-SDK-SECRET` header will be sent by Engage Digital regardless of the survey's **verify secret key** setting.
Please note that the `X-SDK-SECRET` header will be sent by RingCX Digital regardless of the survey's **verify secret key** setting.


## Response Authentication

When sending a request to a Survey SDK bridge, Engage Digital will check both the presence and the validity of the `X-SDK-SECRET` header in the bridge HTTP response.
When sending a request to a Survey SDK bridge, RingCX Digital will check both the presence and the validity of the `X-SDK-SECRET` header in the bridge HTTP response.

If the header is not present or if it doesn't match the survey's **secret key**, the entire response will be considered invalid and will therefore be ignored.

!!! note
Please note that this verification mechanism can be skipped by turning the survey's **verify secret key** setting off in Engage Digital.
Please note that this verification mechanism can be skipped by turning the survey's **verify secret key** setting off in RingCX Digital.


## Realtime Authentication

When receiving a `POST` request from a Survey SDK bridge, Engage Digital will check both the presence and the validity of the `X-SDK-SECRET` header in the bridge HTTP request.
When receiving a `POST` request from a Survey SDK bridge, RingCX Digital will check both the presence and the validity of the `X-SDK-SECRET` header in the bridge HTTP request.

If the header is not present or if it doesn't match the survey's **secret key**, the entire request will be considered invalid and will therefore be ignored.

!!! note
Please note that this verification mechanism can be skipped by turning the survey's **verify secret key** setting off in Engage Digital.
Please note that this verification mechanism can be skipped by turning the survey's **verify secret key** setting off in RingCX Digital.