# Dub Your Toolhouse AI Worker can connect to Dub using 17 specialized tools. ## Auth Connection This service requires an auth connection to use its tools. You can set this up in your Toolhouse dashboard under [Auth Connections](https://toolhouse.app/auth-connections?authkit_slugs=dub). ## Tools (17) ### `Dub Bulk Delete Links` Integration name: **DUB\_BULK\_DELETE\_LINKS** Tool to delete multiple short links in bulk from Dub. Use when you need to remove multiple links at once. Maximum of 100 link IDs per request. Non-existing IDs are silently ignored. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ---------- | ----- | :------: | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | `link_ids` | array | ✅ | `["link_1KEEH8EH10TSN9YVTC88JH9H4","link_1KEEH8JDV00BS154D3F20VN0N"]` | List of link IDs to delete. Maximum of 100 IDs. Non-existing IDs will be ignored. Each ID should be in the format 'link\_XXXXX' or similar. | *** ### `Dub Bulk Update Links` Integration name: **DUB\_BULK\_UPDATE\_LINKS** Tool to update multiple short links in bulk. Use when you need to apply the same updates to multiple links at once by specifying link IDs or external IDs. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------- | ------ | :------: | ------------------------------------ | --------------------------------------------------------------------------------------- | | `data` | object | ✅ | — | The fields to update for all specified links. | | `linkIds` | array | | `["link_1KEEH86942XZC9P7KJR91M5C2"]` | The IDs of the links to update. Takes precedence over `externalIds`. Maximum 100 items. | | `externalIds` | array | | — | The external IDs of the links to update as stored in your database. Maximum 100 items. | *** ### `Dub Create Domain` Integration name: **DUB\_CREATE\_DOMAIN** Tool to add a domain to a Dub workspace. Use when you need to create a new domain for shortening links. The domain must be verified before it can be used for link shortening. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------------------- | ------- | :------: | ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | | `logo` | string | | — | The logo of the domain | | `slug` | string | ✅ | `"acme.com"` | Name of the domain (e.g., yourbrand.com) | | `archived` | boolean | | `false` | Whether to archive this domain. False will unarchive a previously archived domain | | `assetLinks` | string | | — | assetLinks.json configuration file (for deep link support on Android) | | `expiredUrl` | string | | `"https://acme.com/expired"` | Redirect users to a specific URL when any link under this domain has expired | | `notFoundUrl` | string | | `"https://acme.com/not-found"` | Redirect users to a specific URL when a link under this domain doesn't exist | | `placeholder` | string | | `"https://dub.co/help/article/what-is-dub"` | Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened | | `appleAppSiteAssociation` | string | | — | apple-app-site-association configuration file (for deep link support on iOS) | *** ### `Dub Create Tag` Integration name: **DUB\_CREATE\_TAG** Tool to create a new tag in Dub. Use when you need to organize links by creating custom tags. Tags help categorize and filter links for better organization. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | string | ✅ | `"marketing"` | The name of the tag to create. Must be between 1 and 50 characters. | | `color` | string | | `"blue"` | The color of the tag. If not provided, a random color will be assigned from the available options: red, yellow, green, blue, purple, brown, pink. | *** ### `Dub Delete Domain` Integration name: **DUB\_DELETE\_DOMAIN** Tool to delete a domain from your Dub workspace. Use when you need to permanently remove a domain. The domain must exist and be owned by your workspace. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ------------ | -------------------------- | | `slug` | string | ✅ | `"acme.com"` | The domain name to delete. | *** ### `Dub Delete Tag` Integration name: **DUB\_DELETE\_TAG** Tool to delete a tag from Dub. Use when you need to remove a tag that is no longer needed. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | --------------------------------- | ---------------------------- | | `id` | string | ✅ | `"tag_1KEEHB566ECNBS4N9RC0MT413"` | The ID of the tag to delete. | *** ### `Dub Get Link Info` Integration name: **DUB\_GET\_LINK\_INFO** Tool to retrieve details of a specific short link from Dub. Use when you need to get comprehensive information about a link including its configuration, targeting settings, and performance metrics. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------- | ------ | :------: | --------------------- | --------------------------------------------------------------------------------------------------------------------------- | | `key` | string | | `"github"` | The key of the link to retrieve. E.g. for `d.to/github`, the key is `github`. Must be used together with domain parameter. | | `domain` | string | | `"dub.sh"` | The domain of the link to retrieve. E.g. for `d.to/github`, the domain is `d.to`. Must be used together with key parameter. | | `link_id` | string | | `"clux0rgak00011..."` | The unique ID of the short link. | | `external_id` | string | | `"ext_123456"` | This is the ID of the link in your database. Must be prefixed with 'ext\_' when querying. | *** ### `Dub Get Links` Integration name: **DUB\_GET\_LINKS** Tool to retrieve a paginated list of links for the authenticated workspace. Use when you need to list links with optional filtering by domain, tags, folder, search terms, or user. Supports pagination and sorting for efficient retrieval of large link collections. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | -------------- | ------- | :------: | --------- | ---------------------------------------------------------------------------------------------------------------------------- | | `page` | integer | | `1` | The page number for pagination. | | `sort` | string | | — | DEPRECATED. Use `sort_by` instead. | | `tagId` | string | | — | Deprecated: Use `tag_ids` instead. The tag ID to filter the links by. | | `domain` | string | | `"ac.me"` | The domain to filter the links by. E.g. `ac.me`. If not provided, all links for the workspace will be returned. | | `search` | string | | — | The search term to filter the links by. The search term will be matched against the short link slug and the destination url. | | `sortBy` | string | | — | The field to sort the links by. The default is `createdAt`. | | `tagIds` | string | | — | The tag IDs to filter the links by. | | `userId` | string | | — | The user ID to filter the links by. | | `folderId` | string | | — | The folder ID to filter the links by. | | `pageSize` | integer | | `50` | The number of items per page. | | `tagNames` | string | | — | The unique name of the tags assigned to the short link (case insensitive). | | `tenantId` | string | | — | The ID of the tenant that created the link inside your system. If set, will only return links for the specified tenant. | | `withTags` | boolean | | — | DEPRECATED. Filter for links that have at least one tag assigned to them. | | `sortOrder` | string | | — | The sort order. The default is `desc`. | | `showArchived` | boolean | | — | Whether to include archived links in the response. Defaults to `false` if not provided. | *** ### `Dub Get Links Count` Integration name: **DUB\_GET\_LINKS\_COUNT** Tool to retrieve the count of links in workspace with optional filters. Use when you need to get the total number of links matching specific criteria such as domain, tags, folder, or search terms. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | -------------- | ------- | :------: | --------- | ---------------------------------------------------------------------------------------------------------------------------- | | `tagId` | string | | — | Deprecated: Use `tag_ids` instead. The tag ID to filter the links by. | | `domain` | string | | `"ac.me"` | The domain to filter the links by. E.g. `ac.me`. If not provided, all links for the workspace will be returned. | | `search` | string | | — | The search term to filter the links by. The search term will be matched against the short link slug and the destination url. | | `tagIds` | string | | — | The tag IDs to filter the links by. | | `userId` | string | | — | The user ID to filter the links by. | | `groupBy` | string | | — | The field to group the links by. | | `folderId` | string | | — | The folder ID to filter the links by. | | `tagNames` | string | | — | The unique name of the tags assigned to the short link (case insensitive). | | `tenantId` | string | | — | The ID of the tenant that created the link inside your system. If set, will only return links for the specified tenant. | | `withTags` | boolean | | — | DEPRECATED. Filter for links that have at least one tag assigned to them. | | `showArchived` | boolean | | — | Whether to include archived links in the response. Defaults to `false` if not provided. | *** ### `Dub Get Tags` Integration name: **DUB\_GET\_TAGS** Tool to retrieve a list of tags from Dub. Use when you need to fetch all tags or search for specific tags by name or IDs. Supports pagination and sorting by name or creation date. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------ | ------- | :------: | ------- | -------------------------------------- | | `ids` | string | | — | IDs of tags to filter by. | | `page` | integer | | `1` | The page number for pagination. | | `search` | string | | — | The search term to filter the tags by. | | `sort_by` | string | | — | The field to sort the tags by. | | `page_size` | integer | | `50` | The number of items per page. | | `sort_order` | string | | — | The order to sort the tags by. | *** ### `Dub Get Workspace` Integration name: **DUB\_GET\_WORKSPACE** Tool to retrieve detailed information for a specific workspace. Use when you need to get workspace details including plan, usage limits, domains, users, and configuration settings. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------ | ------ | :------: | -------------------------------- | -------------------------------- | | `id_or_slug` | string | ✅ | `"ws_1K1ABQM4F0JEH7T7F4ZF7CR28"` | The ID or slug of the workspace. | *** ### `Dub List Domains` Integration name: **DUB\_LIST\_DOMAINS** Tool to retrieve a list of domains for the authenticated workspace. Use when you need to view all domains, search for specific domains, or filter domains by archived status. Supports pagination for large result sets. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------- | ------- | :------: | --------------- | --------------------------------------------------------------------------------------- | | `page` | integer | | `1` | The page number for pagination. | | `search` | string | | `"example.com"` | The search term to filter the domains by. | | `archived` | boolean | | `false` | Whether to include archived domains in the response. Defaults to false if not provided. | | `page_size` | integer | | `50` | The number of items per page. | *** ### `Dub Track Open` Integration name: **DUB\_TRACK\_OPEN** Tool to track a deep link open event in Dub. Use when you need to record when a user opens your app via a deep link. Supports both direct tracking via deepLink parameter or probabilistic tracking via dubDomain parameter. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------ | ------ | :------: | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `deep_link` | string | | `"https://acme.link/fb-promo"` | The deep link that brought the user to the app. If left blank, Dub will fallback to probabilistic tracking by using the dubDomain parameter to check if there is an associated click event for the user's IP address. Learn more: | | `dub_domain` | string | | `"acme.link"` | Your deep link custom domain on Dub (e.g. 'acme.link'). This is used in probabilistic tracking to check if there is an associated click event for the user's IP address. Learn more: | *** ### `Dub Update Domain` Integration name: **DUB\_UPDATE\_DOMAIN** Tool to update a domain configuration in Dub. Use when you need to modify domain settings like redirect URLs, placeholder text, archive status, or deep linking configurations. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ---------------------------- | ------- | :------: | ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | | `logo` | string | | — | The logo of the domain (URL or data URI) | | `slug` | string | ✅ | `"acme.com"` | The domain name to update (e.g., 'acme.com'). This is the identifier of the domain you want to modify. | | `archived` | boolean | | `false` | Whether to archive this domain. Set to false to unarchive a previously archived domain | | `new_slug` | string | | `"newdomain.com"` | New name of the domain if you want to rename it | | `asset_links` | string | | — | assetLinks.json configuration file (for deep link support on Android) | | `expired_url` | string | | `"https://acme.com/expired"` | Redirect users to a specific URL when any link under this domain has expired | | `placeholder` | string | | `"https://dub.co/help/article/what-is-dub"` | Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened | | `not_found_url` | string | | `"https://acme.com/not-found"` | Redirect users to a specific URL when a link under this domain doesn't exist | | `apple_app_site_association` | string | | — | apple-app-site-association configuration file (for deep link support on iOS) | *** ### `Dub Update Tag` Integration name: **DUB\_UPDATE\_TAG** Tool to update an existing tag by ID. Use when you need to change the name or color of a tag. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | --------------------------------- | ------------------------------------------------------------------------------------ | | `id` | string | ✅ | `"tag_1KEEHB566ECNBS4N9RC0MT413"` | The ID of the tag to update. | | `name` | string | | `"updated-tag-test"` | The name of the tag to update. | | `color` | string | | `"blue"` | The color of the tag. Must be one of: red, yellow, green, blue, purple, brown, pink. | *** ### `Dub Update Workspace` Integration name: **DUB\_UPDATE\_WORKSPACE** Tool to update workspace settings in Dub. Use when you need to modify workspace name, slug, logo, or conversion tracking settings. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | -------------------- | ------- | :------: | -------------------------------- | ----------------------------------------------------------------------------------------------------- | | `logo` | string | | `"https://example.com/logo.png"` | URL of the workspace logo image. | | `name` | string | | `"My Workspace"` | The name of the workspace. Must be between 1 and 32 characters. | | `slug` | string | | `"my-workspace"` | The slug of the workspace. Must be between 3 and 48 characters. | | `id_or_slug` | string | ✅ | `"ws_1K1ABQM4F0JEH7T7F4ZF7CR28"` | The ID or slug of the workspace to update. | | `conversion_enabled` | boolean | | — | Whether the workspace has conversion tracking enabled automatically for new links (d.to/conversions). | *** ### `Dub Upsert Link` Integration name: **DUB\_UPSERT\_LINK** Tool to create or update a short link in Dub. Use when you need to create a new short link or update an existing one. If the link already exists (matching domain and key), it will be updated; otherwise, a new link will be created. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------- | ------- | :------: | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `geo` | object | | — | Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. See for more information | | `ios` | string | | — | The iOS destination URL for the short link for iOS device targeting | | `key` | string | | — | The short link slug. If not provided, a random 7-character slug will be generated | | `ref` | string | | — | The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL | | `url` | string | ✅ | `"https://google.com"` | The destination URL of the short link | | `image` | string | | — | The custom link preview image (og:image). Will be used for Custom Link Previews if `proxy` is true. Learn more: | | `proxy` | boolean | | — | Whether the short link uses Custom Link Previews feature. Defaults to `false` if not provided | | `tagId` | string | | — | Deprecated: Use `tagIds` instead. The unique ID of the tag assigned to the short link | | `title` | string | | — | The custom link preview title (og:title). Will be used for Custom Link Previews if `proxy` is true. Learn more: | | `video` | string | | — | The custom link preview video (og:video). Will be used for Custom Link Previews if `proxy` is true. Learn more: | | `domain` | string | | — | The domain of the short link (without protocol). If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains) | | `prefix` | string | | — | The prefix of the short link slug for randomly-generated keys (e.g. if prefix is `/c/`, generated keys will be in the `/c/:key` format). Will be ignored if `key` is provided | | `tagIds` | — | | `"clux0rgak00011..."` | The unique IDs of the tags assigned to the short link. Can be a single tag ID string or an array of tag IDs | | `android` | string | | — | The Android destination URL for the short link for Android device targeting | | `doIndex` | boolean | | — | Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: | | `rewrite` | boolean | | — | Whether the short link uses link cloaking. Defaults to `false` if not provided | | `archived` | boolean | | — | Whether the short link is archived. Defaults to `false` if not provided | | `comments` | string | | — | The comments for the short link | | `folderId` | string | | — | The unique ID existing folder to assign the short link to | | `password` | string | | — | The password required to access the destination URL of the short link | | `tagNames` | — | | — | The unique name of the tags assigned to the short link (case insensitive). Can be a single tag name string or an array of tag names | | `tenantId` | string | | — | The ID of the tenant that created the link inside your system. If set, it can be used to fetch all links for a tenant | | `utm_term` | string | | — | The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL | | `expiresAt` | string | | — | The date and time when the short link will expire at in ISO-8601 format | | `keyLength` | integer | | — | The length of the short link slug. Defaults to 7 if not provided. When used with `prefix`, the total length of the key will be `prefix.length + keyLength` | | `partnerId` | string | | — | The ID of the partner the short link is associated with | | `programId` | string | | — | The ID of the program the short link is associated with | | `expiredUrl` | string | | — | The URL to redirect to when the short link has expired | | `externalId` | string | | `"123456"` | The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext\_' when passed as a query parameter). This key is unique across your workspace | | `utm_medium` | string | | — | The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL | | `utm_source` | string | | — | The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL | | `webhookIds` | array | | — | An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data | | `description` | string | | — | The custom link preview description (og:description). Will be used for Custom Link Previews if `proxy` is true. Learn more: | | `publicStats` | boolean | | — | Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided | | `utm_content` | string | | — | The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL | | `testVariants` | array | | `[{"url":"https://example.com/variant-1","percentage":50},{"url":"https://example.com/variant-2","percentage":50}]` | An array of A/B test URLs and the percentage of traffic to send to each URL. Must have 2-4 variants | | `utm_campaign` | string | | — | The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL | | `testStartedAt` | string | | — | The date and time when the tests started in ISO-8601 format | | `testCompletedAt` | string | | — | The date and time when the tests were or will be completed in ISO-8601 format | | `trackConversion` | boolean | | — | Whether to track conversions for the short link. Defaults to `false` if not provided | *** --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.toolhouse.ai/toolhouse/integrations/dub.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.