Bitly

Create and manage shortened links with Bitly.

Developer toolsAPI key6 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (6)
archive_bitlink
create_bitlink
create_qr_code
get_bitlink_details
update_bitlink
custom_api_call
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("bitly", "archive_bitlink", {
    "group_guid": "<group_guid>",
    "bitlink": "<bitlink>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Bitly answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "bitly-archive-bitlink",
  name: "Bitly: Archive Bitlink",
  description: "Calls Bitly when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("bitly", {
      "action": "archive_bitlink",
      "group_guid": "<group_guid>",
      "bitlink": "<bitlink>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/bitly/archive_bitlink" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"group_guid":"<group_guid>","bitlink":"<bitlink>"}}'

Actions

archive_bitlinkin catalog

Archive Bitlink. Archive a Bitlink to stop redirects.

Input	Type	Description
`group_guid`required	id (picked from your account)	The group where the item will be managed.
`bitlink`required	id (picked from your account)	Select the Bitlink to modify.

create_bitlinkin catalog

Create Bitlink. Shorten a long URL with optional customization.

Input	Type	Description
`long_url`required	text	The URL to shorten (must include http:// or https://).
`group_guid`required	id (picked from your account)	The group where the item will be managed.
`domain`optional	id (picked from your account)	Domain to use for the Bitlink.
`title`optional	text	Custom title for the Bitlink.
`tags`optional	array	Tags to apply to the Bitlink.
`force_new_link`optional	boolean	Create new link even if one exists for this URL.
`app_id`optional	text	Mobile app identifier (e.g., com.yourapp.name).
`app_uri_path`optional	text	Path within the mobile app (e.g., /product/123).
`install_url`optional	long text	URL where users can install the mobile app.
`install_type`optional	one of "no_install" \| "auto_install" \| "promote_install"	How to handle app installation.

create_qr_codein catalog

Create QR Code. Generate a customized QR code for a Bitlink.

Input	Type	Description
`group_guid`required	id (picked from your account)	The group where the item will be managed.
`destination_type`required	one of "long_url" \| "bitlink_id"	Destination Type
`destination`required	object (depends on other props)	Destination
`title`optional	text	Internal title for the QR Code.
`archived`optional	boolean	Archive the QR code upon creation.
`background_color`optional	text	Hex code (e.g., #FFFFFF)
`dot_pattern_color`optional	text	Hex code (e.g., #000000)
`dot_pattern_type`optional	one of "standard" \| "circle" \| "block" \| "blob" \| "rounded" \| "vertical" \| "horizontal" \| "triangle" \| "heart" \| "star" \| "diamond"	Style: Dot Pattern Type
`corner_1_shape`optional	one of "standard" \| "slightly_round" \| "rounded" \| "extra_round" \| "leaf" \| "leaf_inner" \| "leaf_outer" \| "target" \| "concave"	Corner 1 (Top-Left): Shape
`corner_1_inner_color`optional	text	Corner 1 (Top-Left): Inner Color
`corner_1_outer_color`optional	text	Corner 1 (Top-Left): Outer Color
`corner_2_shape`optional	one of "standard" \| "slightly_round" \| "rounded" \| "extra_round" \| "leaf" \| "leaf_inner" \| "leaf_outer" \| "target" \| "concave"	Corner 2 (Top-Right): Shape
`corner_2_inner_color`optional	text	Corner 2 (Top-Right): Inner Color
`corner_2_outer_color`optional	text	Corner 2 (Top-Right): Outer Color
`corner_3_shape`optional	one of "standard" \| "slightly_round" \| "rounded" \| "extra_round" \| "leaf" \| "leaf_inner" \| "leaf_outer" \| "target" \| "concave"	Corner 3 (Bottom-Right): Shape
`corner_3_inner_color`optional	text	Corner 3 (Bottom-Right): Inner Color
`corner_3_outer_color`optional	text	Corner 3 (Bottom-Right): Outer Color
`gradient_style`optional	one of "no_gradient" \| "linear" \| "radial"	Gradient: Style
`gradient_color_1`optional	text	First gradient color (hex code)
`gradient_color_2`optional	text	Second gradient color (hex code)

get_bitlink_detailsin catalog

Get Bitlink Details. Retrieve metadata for a Bitlink.

Input	Type	Description
`group_guid`required	id (picked from your account)	The group where the item will be managed.
`bitlink`required	id (picked from your account)	Select the Bitlink to modify.

update_bitlinkin catalog

Update Bitlink. Modify properties of an existing Bitlink.

Input	Type	Description
`group_guid`required	id (picked from your account)	The group where the item will be managed.
`bitlink`required	id (picked from your account)	Select the Bitlink to modify.
`title`optional	text	New title for the Bitlink.
`archived`optional	boolean	Archive or unarchive the Bitlink.
`tags`optional	array	Tags to apply (overwrites existing tags).
`app_uri_path`optional	text	Path within the mobile app (e.g., /product/123).
`install_url`optional	long text	URL where users can install the mobile app.
`os`optional	one of "ios" \| "android"	Target mobile operating system.
`install_type`optional	one of "no_install" \| "auto_install" \| "promote_install"	How to handle app installation.

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

Details

Id: bitly
Category: Developer tools
Tags: links, url-shortener, analytics
Package: @activepieces/piece-bitly@0.1.4
Tier: Community