Enduser SSO

The Tickaroo Embed Version 3 is deprecated for all use cases, except for sports. If you are not using sports, we strongly encourage using V4. V3 will not receive any new features of the News Editor V2!

Interactive Liveblog features can directly integrate with your websites users. This creates a seamless experience for your users with no need for an extra sign up step.

General Flow

Customer BackendCustomer WebsiteEmbedJSUserLoad EmbedJS JavascriptSet Current User InformationEmbed a LiveblogDisplays LiveblogWrites a commentClicks on Post CommentRequests Signed IdTokenRequests Signed IdTokenReturns Signed IdTokenReturns Signed IdTokenPosts CommentCustomer BackendCustomer WebsiteEmbedJSUser

EmbedJS needs to know if your User is logged in or not. Your website must supply EmbedJS with information about the User on startup or whenever the login status changes. To start, EmbedJS only needs a users name to display. When the user actaully takes any action like posting a comment, EmbedJS will reqeust a signed IdToken to verify your users identity.

Step By Step Tutorial

This section assumes you already included the Tickaroo EmbedJS script and use it to display Liveblogs. If that is not the case, please start out with “Getting Started”

Step 1: Generate a secret signing key

  1. Log in to your Pro account and navigate to Settings and then Comments.
  2. Click on “Create new singing key”
  3. Follow the steps of the wizard to create and download a signing key
Attention: Keep the secret key secure! Never include the your secret key in your Javascript!

Step 2: Implement the Basic JS API

On your website, tell Tickaroo when a user is logged in:

_tik("setCurrentUser", {
  sub: "123456789",
  name: "JohnDoe",
  idTokenCallback: function() {
    return fetch(/* ... */).json().then(data => data.idToken)

The name field should be the display name of your User.

The idTokenCallback field is a function returning a Promise<string> object. The function should make a call to your backend to retrieve a signed idToken (see Step 3). The easiest way to do this is to use fetch to call your backend and retrieve the IdToken. EmbedJS will call this only when necessary.

Optional, you can log your user out of Tickaroo by issuing this call:

_tik("setCurrentUser", undefined);

Step 3: Sign the IdToken on your Backend

Your backend must implement an endpoint that returns a signed IdToken. An IdToken is a signed JWT with specific predefined claims. Libraries to create and sign JWTs exist for all popular programming environments.

The IdToken must have the following claims:

Header Claims:

  "alg": "HS256" | "RS256" | "ES256"  // The signing algorithm you selected in Step 1
  "kid": string                       // The ID of the key generated in Step 1

Payload Claims:

  "sub": string                       // Your user ID. Must be a string and must be unique
  "exp": number                       // UNIX-Timestamp when this token expires. Should be short lived!
  "name": string                      // The display name of the user
  "picture": string | undefined       // Optional: Provide a link to the users avatar website
  "profile": string | undefined       // Optional: Provide a link to the users profile on your website

We recommend to set the expiration time no further than 2 minutes into the future. This leaves enough room for slow internet connections while still providing a decent protection against replay attacks.

Example implementation in Java using com.auth0:java-jwt assuming HS256 signature:

private Algorithm algorithm = Algorithm.HMAC256(Base64.getDecoder().decode("..."));

public String signJWT(User user) {
  Date expires = new Date(System.currentTimeMillis() + 120_000);
  return JWT.create()
              .withClaim("name", user.getName())

Optional: Let EmbedJS trigger a login flow

EmbedJS can display a login button to trigger your login flow if necessary. To activate this behaviour you need to provide a callback function for the button:

_tik("setTriggerLoginFunction", function() {
  // Trigger your login flow...