Bitly is a link management platform that businesses use to create short links, branded links, and QR codes, and to organize them into groups, campaigns, and channels.
Hevo uses the Bitly API to replicate the account data of your Bitly organization, such as its groups, users, campaigns, and channels, to the Destination of your choice. To ingest data, you must provide Hevo with an access token of your Bitly account.
Supported Features
| Feature Name | Supported |
|---|---|
| Capture deletes | Yes |
| History mode | No |
| Custom data (user-configured tables & fields) | No |
| Data blocking (skip objects and fields) | Yes |
| Resync (objects and Pipelines) | Yes |
| API configurable | Yes |
Prerequisites
-
An active Bitly account from which data is to be ingested.
-
The password of your Bitly account, to generate an access token.
Generate an Access Token
Hevo connects to your Bitly account using an access token. The token has the same access as the Bitly user who generates it, so Hevo can read the data of the groups and organizations that the user belongs to. Bitly allows only one access token for each combination of accounts. If a token already exists, Bitly displays it instead of generating a new one.
Perform the following steps to generate an access token:
-
Log in to your Bitly account.
-
In the left navigation pane, click Settings, and then under Developer settings, click API.
-
In the Access tokens section, click Generate token.
-
In the Re-authenticate to generate a token dialog, click Continue, and then log in to your Bitly account again.
-
Click the copy icon to copy the access token, and save it securely like any other password. If a token already exists for your account, Bitly displays it in the Token already exists dialog. Copy that token.
Read Authentication for more information about access tokens.
To generate a new token, you must first revoke the existing one by clicking Revoke access in the Access tokens section. If the access token is revoked, or the user who generated it is removed from your Bitly account, Hevo cannot connect to your account, and the Pipeline fails. To resume data ingestion, generate a new token and modify the Source configuration with it.
Configure Bitly as a Source in your Pipeline
Perform the following steps to configure your Bitly Source:
-
Click Pipelines in the Navigation Bar.
-
Click + Create Pipeline in the Pipelines List View.
-
On the Select Source Type page, select Bitly.
-
On the Select Destination Type page, select the type of Destination you want to use.
-
In the Configure Source screen, specify the following:
-
Source Name: A unique name for your Source, not exceeding 255 characters. For example, Bitly Source.
-
In the Connect to Bitly section, specify the following:
- Access Token: The access token that you generated in Bitly.
-
-
Click Test & Continue to test the connection to your Bitly Source. Hevo checks the connection by reading the details of the user who generated the access token. The test fails if Bitly rejects the access token. Once the test is successful, you can proceed to set up your Destination.
Data Replication
Hevo replicates data for all the objects selected on the Configure Objects page during Pipeline creation. By default, all supported objects and their available fields are selected. However, you can modify this selection while creating or editing the Pipeline. To ingest a child object, you must also select its parent object.
Hevo ingests the entire data of all the selected objects in each run, as per the sync frequency.
You can resync the parent objects. To resync a child object, resync its parent object.
Bitly limits the number of API requests that an account can make per hour and per minute, based on the API endpoint and your subscription plan. Read Rate limits.
Note: You can create a Pipeline with this Source only using the Merge load mode. The Append mode is not supported for this Source.
Schema and Primary Keys
Hevo uses the following schema to upload the records in the Destination. For a detailed view of the objects, fields, and relationships, click the ERD.
Data Model
The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:
| Object | Description |
|---|---|
| Campaign | Contains the campaigns created in your Bitly account, including the name, description, group, and creator of each campaign. |
| Channel | Contains the channels created in your Bitly account, including the name and group of each channel. |
| Groups | Contains the groups that the user can access, including the name, organization, role of the user, and status of each group. It includes the following child objects: - Group BSDs - Group Preference |
| Group BSDs | Contains the branded short domains (BSDs) assigned to each group. |
| Group Preference | Contains the default domain that each group uses to create short links. |
| Organization | Contains the organizations that the user belongs to, including the name, subscription tier, role of the user, and security settings of each organization. It includes a child object, Organization BSDs. |
| Organization BSDs | Contains the branded short domains (BSDs) of each organization. |
| Users | Contains the details of the user who generated the access token, such as the login, name, default group, and security settings. It includes a child object, User Email. |
| User Email | Contains the email addresses of the user, and whether each address is primary and verified. |
Additional Information
Read the detailed Hevo documentation for the following related topics:
Handling of Deletes
Hevo captures deletes by comparing the data ingested from the Source with the data present in the Destination in each run. If a record exists in the Destination but is no longer returned by the Source, Hevo marks it as deleted by setting the value of the metadata column __hevo__marked_deleted to True. The record remains in the Destination with all its data. This applies to all the objects except User Email, for which Hevo replaces the email addresses of the user in each run.
Source Considerations
-
Hevo ingests the data that the user who generated the access token can access. The Users object contains only this user, and not all the users of your organization.
-
The Campaign and Channel objects contain data only if you create campaigns and channels in Bitly. The Group BSDs and Organization BSDs objects contain data only if you use a custom domain, which requires a paid Bitly plan.
-
The date and time fields, such as created and modified, are loaded as text in the ISO 8601 format, for example, 2026-10-30T08:12:45+0000.
Limitations
- Hevo does not ingest the short links (Bitlinks), QR codes, or click metrics of your Bitly account.