Templates - Bitly Outbound Configuration

Rebekah Garner
Rebekah Garner
  • Updated

Bitly is the largest link management platform used globally to create short, branded call-to-action links. Adding Bitly to Claravine allows users to create standardized shortened links that are associated to metadata for analytics teams and create company-branded shortened links.

 

In Claravine, the user will see both the shortened URL and full URL in the submission table.

  • Claravine will send the Shortened Link and full Link to Bitly
  • Edited submission links will not update to Bitly
  • A Bitly integration can be added to a new or existing template


 The Bitly integration is a paid feature. To request a demo or to have it added to your account, please reach out to your Customer Success Manager.

 

Watch the Video to connect Claravine + Bitly and add it to a template:

 

 

To Add the Bitly Outbound Integration to a Template:

  1. Open the correct Template in the Templates Sub-Navigation menu.

  2. Click Step 3 - Connect.


  3. Click  to add a new Outbound integration.


  4. Click Bitly.
         The Bitly Outbound configuration section displays.
    mceclip0.png

  5. Select the connected Bitly Account. 
    An Administrator must first connect the Bitly Account in the Accounts Sub-Navigation menu of Integrations.

  6. Select the Organization.

  7. Select the Group.

  8. Select the Short Domain. Click Save to save the template.

    Optional: Create a Custom Back-Half
     

    Claravine has the capability of creating custom, branded links. You can customize the part of your short link after the last forward-slash (aka back-half or hash value) with customized letters and numbers through your Claravine template (e.g. bit.ly/BACK-HALF). The customized back-half of your Bitly shortened link can be configured to populate from a list value, text field, auto number, concatenation, etc.

    It is recommended that the connected Bitly account associated with the template uses branded link for a custom domain (e.g. clr.vn) instead of a generic bit.ly domain.
    If users have created submissions with the Bitly integration prior to adding the custom bak-half, they cannot edit the submission to add a custom back-half. It is recommended to duplicate the template and version out the original non-custom back-half template.

  9. Add a field to the template that you want to populate the custom back-half value. This value or phrase is used to better identify the link and must be unique. 
      1. In Step2 Define and Govern, click the +Select Fields button at the bottom of the template schema.
      2. Create a new field to fill in the custom back-half. Click the + next to a Field Set.     
      3. In the Add New Field side-menu, add the Name (Bitly Custom Back-Half), check if it is required, and select the Field Type.
        • If it is a Text field, remember the dash (-) and underscore (_) are the only allowed symbols in a back-half value. It is recommended to exclude all symbols in the Exclude field except for dash and underscore.
      4. Click Done.

  10. Find the newly created Field and add it to the template schema and reorder as needed.

  11. In Step 3 Connect, click on the Bitly Outbound integration accordion drawer to expand it.

  12. It is strongly recommended to use the branded short domain (clr.vn) and not the generic (bit.ly).

  13. Check the box to customize the back-half of shortened Bitly links from this template.

  14. In the Map from Claravine field, select the newly created Bitly Custom Back-Half field.

  15. In the Map to Bitly field, select Custom Bitlink.
    mceclip0.png

  16. Click Save to save the template.

  17. Claravine creates a System Field Set for the Bitly link, do not delete this Field Set. The Shortened Link field is automatically added to the template schema. Reorder the field as desired but do not remove this field.

 

User Experience

The user enters the full landing page into the Link column. The Shortened Link field is locked and cannot be edited.

When all required fields and governance is met, click Submit.
mceclip1.png

The Link populates with the Pattern in full, and the Shortened Link field populates with the organization branded short domain.
mceclip0.png

Both the full Link and Shortened Link are passed to Bitly.

 

 

Bitly Platform Limits

Platform limits apply to all accounts, regardless of the subscription plan. Bitly enforces per-hour, per-minute, and per-IP rate limits for each API endpoint.

IP address limit: API users are limited to a maximum of five concurrent connections from a single IP address.

Hourly limits: The rate limits reset once each hour and once each minute. The per-minute limit is one-tenth of the hourly limit. So if your limit for the /v4/shorten endpoint is 1,000 calls per hour, it will also be limited to 100 calls per minute.

Requesting higher hourly limits: Increasing platform limits requires a subscription to a custom enterprise-level account. To discuss an increase to your hourly limits, please contact your Bitly Account Manager for assistance.

You can also find your monthly link limits by logging into Bitly, clicking the profile menu, selecting Change Group, and then clicking Manage next to the appropriate account name. This will take you to the Account Settings page.

 

Dynamic Parameters: Bitly does not allow dynamic parameters as part of the final URL (i.e. claravine.com?rid=<%= recipient.id %>&cid=12345)

 

 

Important Reminders About Custom Back-Half Values

If users created submissions when the template utilized one branded short domain prior to an Admin changing the Bitly configuration to another branded short domain

If a submission shows the text “BITLY_SUBMISSION_ERROR”, it means this custom link is taken, you'll need to enter a different back-half. This is because someone has already used that back-half with that domain, whether it's bit.ly or your own custom domain. Once a back-half is used for one link, it is permanently tied to that link. It cannot be used again or “freed up” later, even if you go back and edit the custom link in your account. See Bitly support.

Since Bitly links are case sensitive, try changing the capitalization. You can also add other characters, like numbers or a hyphen.  For example, if someone has used yourdomain.com/sample, and you wanted to use the sample back-half, you could try yourdomain.com/Sample or yourdomain.com/sample2022.

All letters a-z in upper case and lower case letters are considered unique. All numbers are allowed. Dash (-) and underscore (_) are the only allowed symbols.

All Bitly links are case sensitive so if a back-half value has been used, consider using upper or lower case letters.

When using a Bitly outbound integration, the template must include a link field and value in the link field must be provided. We recommend link fields are configured to be required when building your template. If a link is not provided, the submission will fail.

 

Comments

0 comments

Article is closed for comments.