Overview
Bitly
This CDK catalogue package is pinned to @activepieces/piece-bitly@0.2.0 and declares 6 declared actions and 1 declared trigger. Its definition is derived from the exact reviewed Activepieces source.
Provider runtime verification is recorded separately when an approved test connection is exercised; this catalogue entry does not claim that verification.
Technical guide
Technical reference
- Package:
@activepieces/piece-bitly@0.2.0 - Exact artifact digest:
sha256:a2b01492ad6c60b187decfd46379623724122a2f054ccbcc9127ed354319bf9f - Source: the exact reviewed Activepieces source
- Authentication, action and trigger schemas are taken from the exact pinned package.
Capability summary
Authentication
Authentication method: custom
Authentication profiles
connection · custom
- Access Token Required · protected credential
Supported objects
| Object | Read | Write | Notes |
|---|---|---|---|
| Archive Bitlink | Yes | No | |
| Create Bitlink | Yes | No | |
| Create QR Code | Yes | No | |
| Get Bitlink Details | Yes | No | |
| Update Bitlink | Yes | No | |
| Custom API Call | Yes | No | |
| New Bitlink Created | Yes | No | Trigger contract validated offline; live event delivery is tracked separately. |
Supported actions
Archive Bitlink · Read
Archive a Bitlink to stop redirects.
archive_bitlink · Risk: low · Retry: safe
Inputs
group_guid· string · Required, The group where the item will be managed.bitlink· string · Required, Select the Bitlink to modify.
Create Bitlink · Read
Shorten a long URL with optional customization.
create_bitlink · Risk: low · Retry: safe
Inputs
long_url· string · Required, The URL to shorten (must include http:// or https://).group_guid· string · Required, The group where the item will be managed.domain· string · Optional, Domain to use for the Bitlink.title· string · Optional, Custom title for the Bitlink.tags· array · Optional, Tags to apply to the Bitlink.force_new_link· boolean · Optional, Create new link even if one exists for this URL.app_id· string · Optional, Mobile app identifier (e.g., com.yourapp.name).app_uri_path· string · Optional, Path within the mobile app (e.g., /product/123).install_url· string · Optional, URL where users can install the mobile app.install_type· string · Optional, How to handle app installation.
Create QR Code · Read
Generate a customized QR code for a Bitlink.
create_qr_code · Risk: low · Retry: safe
Inputs
group_guid· string · Required, The group where the item will be managed.destination_type· string · Requireddestination· object · Requiredtitle· string · Optional, Internal title for the QR Code.archived· boolean · Optional, Archive the QR code upon creation.background_color· string · Optional, Hex code (e.g., #FFFFFF)dot_pattern_color· string · Optional, Hex code (e.g., #000000)dot_pattern_type· string · Optionalcorner_1_shape· string · Optionalcorner_1_inner_color· string · Optionalcorner_1_outer_color· string · Optionalcorner_2_shape· string · Optionalcorner_2_inner_color· string · Optionalcorner_2_outer_color· string · Optionalcorner_3_shape· string · Optionalcorner_3_inner_color· string · Optionalcorner_3_outer_color· string · Optionalgradient_style· string · Optionalgradient_color_1· string · Optional, First gradient color (hex code)gradient_color_2· string · Optional, Second gradient color (hex code)gradient_angle· number · Optionalgradient_exclude_corners· boolean · Optionalframe_id· string · Optionalframe_primary_color· string · Optionalframe_secondary_color· string · Optionalframe_background_color· string · Optionalframe_text· string · Optional, Primary text for frames that support it.logo_image_guid· string · Optional, A GUID for a logo image previously uploaded to Bitly.bitly_brand· boolean · Optional, Show the Bitly logo in the bottom right corner.error_correction· string · Optional
Get Bitlink Details · Read
Retrieve metadata for a Bitlink.
get_bitlink_details · Risk: low · Retry: safe
Inputs
group_guid· string · Required, The group where the item will be managed.bitlink· string · Required, Select the Bitlink to modify.
Update Bitlink · Read
Modify properties of an existing Bitlink.
update_bitlink · Risk: low · Retry: safe
Inputs
group_guid· string · Required, The group where the item will be managed.bitlink· string · Required, Select the Bitlink to modify.title· string · Optional, New title for the Bitlink.archived· boolean · Optional, Archive or unarchive the Bitlink.tags· array · Optional, Tags to apply (overwrites existing tags).app_uri_path· string · Optional, Path within the mobile app (e.g., /product/123).install_url· string · Optional, URL where users can install the mobile app.os· string · Optional, Target mobile operating system.install_type· string · Optional, How to handle app installation.
Custom API Call · Read
Make a custom API call to a specific endpoint
custom_api_call · Risk: low · Retry: safe
Inputs
url· object · Requiredmethod· string · Requiredheaders· object · Optional, Authorization headers are injected automatically from your connection.queryParams· object · Optional, Appended to the URL as ?key=value.body_type· string · Optionalbody· object · Optionalresponse_is_binary· boolean · Optional, Enable for files like PDFs, images, etc.failsafe· boolean · Optional, On a failed request, output the error instead of failing the step.timeout· number · Optional, Seconds to wait for a response. Empty: up to the flow limit (10 min).followRedirects· boolean · Optional, Follow 3xx redirects instead of returning them as the response.
Triggers
New Bitlink Created · Poll
Fires when a new Bitlink is created.
Inputs
pollingInterval· stringgroup_guid· stringtitleFilter· stringtagFilter· stringincludeArchived· boolean
Setup
Setup
Create a tenant connection only in the consuming Studio instance when this connector is made available there. Credentials remain in that tenant's Vault-backed connection and are not stored in CDK package metadata.
Limitations
The package has passed deterministic offline package-load and contract validation. No provider credentials, provider API call or live webhook delivery is represented by this release state.