Integrations allow you to extend the capabilities of Dub and seamlessly connect with third-party platforms and services.

In this guide, you will learn how to create and manage integrations on Dub, allowing you to incorporate Dub’s link management infrastructure into your application.

Dub supports OAuth 2.0 authentication, which is recommended if you build integrations extending Dub’s functionality.

We recommend you use a OAuth client library to integrate the OAuth flow. You can find recommended libraries in a variety of programming languages here.

​
Set up OAuth 2.0

Here is a step-by-step guide on how to set up OAuth 2.0 authentication with Dub.

1

Create an OAuth2 application in Dub

  • Go to the OAuth Apps tab in your workspace.
  • Click on Create OAuth App.
  • Fill in the required fields to create an OAuth2 application.
2

Redirect users to authorization URL

When you want to authenticate a user, you need to redirect them to the Dub OAuth authorization URL.

GET https://app.dub.co/oauth/authorize

Parameters:

PropertyDescription
client_idThe client ID of your OAuth application.
redirect_uriThe URL to redirect the user to after they authorize the application. Make sure this URL is registered in your OAuth application.
response_typeExpected response type. It should be code.
scopeA space separated list of scopes that you want to request access to. Read more about scopes here.
stateThe state parameter to prevent against CSRF attacks. Read more about it here

An example URL would look like this:

GET https://app.dub.co/oauth/authorize?client_id=YOUR_CLIENT_ID&redirect_uri=YOUR_REDIRECT_URI&response_type=code&scope=SOME_SCOPE&state=SOME_STATE
3

Exchange code for an access token

The code parameter is returned in the query string when the user is redirected back to your application. You can exchange this code for an access token by making a POST request to the Dub OAuth token URL.

POST https://api.dub.co/oauth/token

The Content-Type header should be set to application/x-www-form-urlencoded.

Parameters:

PropertyDescription
codeThe code you received when the user was redirected back to your application.
client_idThe client ID of your OAuth application.
client_secretThe client secret of your OAuth application.
redirect_uriThe same redirect URI you used in the authorization URL.
grant_typeThe grant type. It should be authorization_code.

Response:

After a successful request, you will receive a JSON response with the access token.

{
  "access_token": "dub_access_token_ae8ebf6f97e6200d886ef48a5...",
  "refresh_token": "7f5acfbe14bca0a20fe6e430ddb7bb494eed160bd...",
  "token_type": "Bearer",
  "expires_in": 7200,
  "scope": "links.write tags.write domains.read"
}

We recommend using the PKCE flow for native desktop or mobile application or a single-page app (SPA) where the client_secret cannot be hidden.

With PKCE, the client_secret is never sent to the authorization server, preventing the client_secret from being leaked from the client application.

Instead of using the client_secret, you will need to generate a code_verifier and code_challenge and use them to exchange for an access token.

For example Dub Raycast extension uses PKCE to authenticate users.

4

Make an API request with the access token

Once you have obtained a valid access token, you can use it to make requests to the Dub API.

You can initialize Dub SDK with the access token.

Here is an example of how you can create a link using the Dub TypeScript SDK:

import { Dub } from "dub";

const dub = new Dub({
  token: <ACCESS_TOKEN>,
});

const link = await dub.links.create({
  url: "https://google.com",
});

Or pass the access token in the header: Authorization: Bearer <ACCESS_TOKEN>

  curl --request POST \
  --url https://api.dub.co/links \
  --header 'Authorization: Bearer <ACCESS_TOKEN>' \
  --header 'Content-Type: application/json'
5

Refresh the access token

Dub access tokens are short-lived, depending on the expires_in value. Dub will respond with 401 Unauthorized if you try to use an expired access token.

To refresh the access token, you need to make a POST request to the Dub OAuth token URL with the refresh_token you obtained when exchanging the code for an access_token.

POST https://api.dub.co/oauth/token

The Content-Type header should be set to application/x-www-form-urlencoded.

Parameters:

PropertyDescription
client_idThe client ID of your OAuth application.
client_secretThe client secret of your OAuth application.
grant_typeThe grant type. It should be refresh_token.
refresh_tokenThe refresh token you received when exchanging the code for an access token.

Response:

After a successful request, you will receive a JSON response with the new access token.

{
  "access_token": "dub_access_token_ae8ebf6f97e6200d886ef48a5...",
  "refresh_token": "7f5acfbe14bca0a20fe6e430ddb7bb494eed160bd...",
  "token_type": "Bearer",
  "expires_in": 7200,
  "scope": "links.write tags.write domains.read"
}

This will invalidate the old access token and refresh token.

​
Scopes

You can request access to specific scopes when redirecting users to the Dub OAuth authorization URL. Scopes are permissions that the user needs to grant to your application.

Dub supports the following scopes for OAuth 2.0:

ScopeDescription
workspaces.readRead access to workspaces.
workspaces.writeWrite access to workspaces.
links.readRead access to links.
links.writeWrite access to links.
tags.readRead access to tags.
tags.writeWrite access to tags.
analytics.readRead access to analytics.
domains.readRead access to domains.
domains.writeWrite access to domains.
user.readRead access to user information. This scope is included by default.

​
Examples

OAuth 2.0 Example

See the full example on GitHub.

Dub also supports API key authentication; however, it is not recommended for building integrations. It should only be used for internal integrations or personal projects that do not require user consent.

Learn more about API Keys.

Was this page helpful?

OverviewWebhooks