Portal endpoints

The portal allow you to easily authorize users and get access to their data in the tools you are connecting to.

Please refer on the unified api setup to understand how to setup the portal.

This page explains all the endpoints related to this portal (the only one you really need is getPortal) and the next pages in this section are all about setting up OAuth with the various providers we support.

GET - /portal/url

*Don't want to do the OAuth flow yourself? You can rely instead on our OAuth portal that will do the whole OAuth exchange and securely save tokens for you.* Request an url for the OAuth portal. You need to redirect your user to this url. This url is pre-authenticated, single use and valid for 5 minutes.

URL Parameters

vendor

required

Atlassian

Clickup

Dropbox

Google

Hubspot

Microsoft

Notion

Salesforce

Slack

scope

optional

string

A string with all the scopes you will request to the user. Refer to the third party documentation on which scopes are available. Leave empty when scopes are not required by the third party

yourUserID

required

string

The id of the user in your database

Responses

200

url

required

string

A pre-authenticated url you need to redirect your user to. Note that the url will expire after 5 minutes

Webhook

This webhook will be trigerred whenever your user has completed the authorization flow;

    ts
    // POST - /your/webhook

interface body: {
  /** Your user ID */
  yourUserID: string;
  /** The user ID from the vendor */
  userIDInTool: string;
  /** A hint to display to the user to recognise which account they authorized */
  accountHint: string | undefined;
  /** A list of workspace ID, they can be loosely considered as tenant IDs */
  workspaceIDList: string[];
  /** The scopes authorized by your user */
  scope: string[];
  /** The vendor that was authorized */
  vendor: Vendor;
}