Single Sign On
Our Single Sign On integration allows users of your application to login to Big Interview without having to enter a password. This is accomplished by generating a token using our Partner API and redirecting the user to a specific URL with that token.

Overview
The Single Sign On Integration is a simple, 2-step process, both being outlined below:

Generate an SSO Token
Redirect to Big Interview with the token
Step 1: Generating the SSO Token
Generating the token needed for Single Sign On is outlined in the our API docs above, but the following might be an example request and response for a user with a partner_id of abc123:



The user.token object contains the token attribute which should be used in Step 2 of the Single Sign On process. In the above example, this would be 19633c68.

Step 2: Redirecting to Big Interview
With the token from Step 1 in hand, your client should then redirect the user to your organizations SSO URL. That URL will take the following format:


Assuming XYZ Corporation has a Big Interview application at the xyz subdomain, and they would like to login the user using the token returned from Step 1, the SSO Redirect URL will take the following format:


After performing this redirect, the Single Sign On process is complete and your user will be logged in to the Big Interview web application.

SSO Secondary Redirects
By default, users signing in to Big Interview through the SSO integration will be redirected to the member dashboard, which is at the following URL:


To have this integration redirect the user to different section of the Big Interview application, you can supply a redirect_to parameter to the SSO login resource URL and we will point the user there after login instead.

Example
Say you want to direct the user to a yet to be completed item in one of Big Interview’s track guides and you have the following information:

You have the following SSO token for one of their users: 935d85189822bf9c.
You would like to direct that user to an uncompleted track located at /members/curriculum?chapter=6.
We can do that with the following URL parameters:



User Return URL
By default, your users will be redirected to the Big Interview landing page for your organization after they logout. If that is not where you would like them to end up, you can supply us with a return_url parameter during the SSO login. For instance, if you want the user to be redirected to https://google.com/ after they logout, you would construct your SSO login url like so:



Webhooks
Webhooks are a system of automated notifications indicating that an event has occurred which was linked to one of your users in our system. Rather than requiring you to pull information via our API, webhooks push information to your destination when important events occur.

Notifications are are delivered via HTTP POST requests to a destination endpoint on your server and are sent based on a list of events. Each webhook contains a notification type and the full API object that the notification is reporting on. This information can be used to update your system or to trigger business processes.

Registering webhooks
Registering a webhook can be done through your organization’s admin area, which you can reach by replacing {org} in the following url with the subdomain for your organization:



Handling webhooks
Assuming the following webhook registration details:

URL: https://app.mywebsite.com/webhooks/biginterview
Key: 935d85189822bf96c28c4fa79d3d8f31
Your endpoint should be able to handle the following request:



Retries
We will resend webhook notifications every 10 minutes for a total of 6 attempts over an one hour until both of the following are true:

The webhook completes within 30 seconds.
The webhook receives a 200 response.

Volume and Order
We strive to send webhook notifications as quickly as events occur in our system and in the exact order that they occurred. It is possible that, if your system does not handle our requests correctly and in a timely fashion, you may receive events out of order or in an order that does not match with your system.

The webhook object
The following describes the attributes related to a webhook. Please note that the actual webhook POST-ed to your server will be additionally namespaced under the webhook key.


List of Events
The following is a list of events our webhook notification service will send out.

Was this article helpful?
Cancel
Thank you!