Update Bitlink with Bitly API on New Webhook Event (Instant) from Heroku API

Pipedream makes it easy to connect APIs for Bitly, Heroku and 2,900+ other apps remarkably fast.

Trigger workflow on

New Webhook Event (Instant) from the Heroku API

Next, do this

Update Bitlink with the Bitly API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Heroku trigger and Bitly action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Webhook Event (Instant) trigger
1. Connect your Heroku account
2. Select a App ID
3. Select one or more Entities
Configure the Update Bitlink action
1. Connect your Bitly account
2. Configure Bitlink
3. Optional- Configure References
4. Optional- Configure Link
5. Optional- Configure ID
6. Optional- Configure Long Url
7. Optional- Configure Bitlink Title
8. Optional- Configure Bitlink Archived
9. Optional- Configure Created At
10. Optional- Configure Created By
11. Optional- Configure Client ID
12. Optional- Configure Custom Bitlinks
13. Optional- Configure Tags
14. Optional- Configure Launchpad IDs
15. Optional- Configure Deeplinks
16. Optional- Configure Is Deleted
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Webhook Event (Instant) on Heroku

Description:Emit new event on each webhook event. [See the documentation](https://devcenter.heroku.com/articles/app-webhooks-schema#webhook-create)

Version:0.0.1

Key:heroku-new-webhook-event-instant

View on GitHub

Heroku Overview#

The Heroku API offers programmatic access to Heroku's cloud platform, enabling developers to automate, extend, and integrate their app's lifecycle events with other services. With Pipedream, you can harness the Heroku API for powerful automation, such as managing apps, dynos, add-ons, and configuring scaling operations. Pipedream's ability to connect with multiple services allows for creating complex workflows, such as syncing your development pipeline with external project management tools or triggering alerts based on app metrics.

Trigger Code#

import heroku from "../../heroku.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "heroku-new-webhook-event-instant",
  name: "New Webhook Event (Instant)",
  description: "Emit new event on each webhook event. [See the documentation](https://devcenter.heroku.com/articles/app-webhooks-schema#webhook-create)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    heroku,
    http: "$.interface.http",
    db: "$.service.db",
    appId: {
      propDefinition: [
        heroku,
        "appId",
      ],
    },
    entities: {
      propDefinition: [
        heroku,
        "entities",
      ],
    },
  },
  hooks: {
    async activate() {
      const { id } = await this.heroku.createWebhookSubscription({
        appId: this.appId,
        data: {
          include: this.entities,
          level: "notify",
          url: this.http.endpoint,
        },
      });
      this._setHookId(id);
    },
    async deactivate() {
      const hookId = this._getHookId();
      if (hookId) {
        await this.heroku.deleteWebhookSubscription({
          appId: this.appId,
          hookId,
        });
      }
    },
  },
  methods: {
    _getHookId() {
      return this.db.get("hookId");
    },
    _setHookId(hookId) {
      this.db.set("hookId", hookId);
    },
    generateMeta(event) {
      return {
        id: event.id,
        summary: `New ${event.webhook_metadata.event.include} - ${event.action} Event`,
        ts: Date.now(),
      };
    },
  },
  async run(event) {
    const { body } = event;
    if (!body) {
      return;
    }
    const meta = this.generateMeta(body);
    this.$emit(body, meta);
  },
  sampleEmit,
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Heroku	`heroku`	`app`	This component uses the Heroku app.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
App ID	`appId`	`string`	Select a value from the drop down menu.
Entities	`entities`	`string[]`	Select a value from the drop down menu:`{ "value": "api:addon-attachment", "label": "addon-attachment - An add-on has been attached or removed from the app" }{ "value": "api:addon", "label": "addon - An add-on for the app has been newly provisioned or deleted, or its details have been modified" }{ "value": "api:app", "label": "app - The app itself has been provisioned or deleted, or its details have been modified" }{ "value": "api:build", "label": "build - A new build for the app has been initiated or the build’s status has changed since the last notification" }{ "value": "api:collaborator", "label": "collaborator - A collaborator has been added or removed from the app, or an existing collaborator’s details have been modified" }{ "value": "api:domain", "label": "domain - Custom domain details have been added or removed from the app" }{ "value": "api:dyno", "label": "dyno - A new dyno has begun running for the app" }{ "value": "api:formation", "label": "formation - The dyno formation for a particular process type has been modified" }{ "value": "api:release", "label": "release - A new release for the app has been initiated or the release’s status has changed since the last notification" }{ "value": "api:sni-endpoint", "label": "sni-endpoint - An SNI endpoint has been specified or removed for the app, or the existing SNI endpoint’s details have been modified" }`

Trigger Authentication#

Heroku uses OAuth authentication. When you connect your Heroku account, Pipedream will open a popup window where you can sign into Heroku and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Heroku API.

Pipedream requests the following authorization scopes when you connect your account:

global

About Heroku#

Cloud infrastructure

Action#

Update Bitlink on Bitly

Description:Updates fields in the specified link

Version:0.0.2

Key:bitly-update-bitlink

View on GitHub

Bitly Overview#

The Bitly API enables you to programmatically shorten URLs, track click rates, and manage link performance metrics. By integrating Bitly with Pipedream, you can automate various tasks around link management and amalgamate Bitly’s capabilities with other services, thereby streamlining digital marketing efforts, enhancing social media strategies, and monitoring engagement through data-driven insights.

Action Code#

import bitly from "../../bitly.app.mjs";
import { formatArrayStrings } from "../../common/utils.mjs";
import constants from "../../common/constants.mjs";

export default {
  name: "Update Bitlink",
  version: "0.0.2",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  key: "bitly-update-bitlink",
  description: "Updates fields in the specified link",
  props: {
    bitly,
    bitlink: {
      type: "string",
      label: "Bitlink",
      description: "A Bitlink made of the domain and hash",
    },
    references: {
      type: "object",
      optional: true,
      label: "References",
      description: "Bitlink references",
    },
    link: {
      type: "string",
      optional: true,
      label: "Link",
      description: "Complete bitlink url",
    },
    id: {
      type: "string",
      optional: true,
      label: "ID",
      description: "Bitlink ID",
    },
    longUrl: {
      type: "string",
      optional: true,
      label: "Long Url",
      description: "Url that was shortened",
    },
    title: {
      type: "string",
      optional: true,
      label: "Bitlink Title",
      description: "Bitlink title",
    },
    archived: {
      type: "boolean",
      optional: true,
      label: "Bitlink Archived",
      description: "Archived bitlink (true or false)",
    },
    createdAt: {
      type: "string",
      optional: true,
      label: "Created At",
      description: "Bitlink created date. Example: 2006-03-12T16:29:46+0000",
    },
    createdBy: {
      type: "string",
      optional: true,
      label: "Created By",
      description: "Bitlink created_by ID",
    },
    clientId: {
      type: "string",
      optional: true,
      label: "Client ID",
      description: "Bitlink client ID",
    },
    customBitlinks: {
      type: "string[]",
      optional: true,
      label: "Custom Bitlinks",
      description: `Provide an array of custom bitlinks
        Example: 
        \`[
          "https://microsoft.com/documentation",
          "https://github.com/contact",          
          "https://gitlab.com/forum",
          "https://pipedream.com/chat          
        ]\`
      `,
    },
    tags: {
      type: "string[]",
      optional: true,
      label: "Tags",
      description: "Enter array of tags",
    },
    launchpadIds: {
      type: "string[]",
      optional: true,
      label: "Launchpad IDs",
      description: "Enter array of Launchpad IDs",
    },
    deeplinks: {
      type: "string[]",
      optional: true,
      label: "Deeplinks",
      description: `Provide an object. Each object should represent a row.
        Example: 
        \`
            { 
              "guid": "Ra1bcD2eF3h", 
              "bitlink": "bit.ly/documentation", 
              "app_uri_path": "/store?id': '123456", 
              "install_url": "https://play.google.com/store/apps/details?id=com.bitly.app',
              "app_guid": "Ab1cdE2fG3h", 
              "os": "android", 
              "install_type": "promote_install",
              "created": "2011-10-05T14:48:00.000Z",
              "modified": "2011-10-06T14:48:00.000Z"
              "brand_guid": "Ba1bc23dE4F" 
            } 
        \`
      `,
    },
    isDeleted: {
      type: "boolean",
      optional: true,
      label: "Is Deleted",
      description: "Bitlink deleted (true or false)",
    },
  },
  type: "action",
  methods: {},
  async run({ $ }) {
    const {
      bitlink,
      deeplinks,
      tags,
    } = this;

    const updatedDeepLink = formatArrayStrings(
      deeplinks,
      constants.ALLOWED_DEEPLINK_KEYS,
      "deeplinks",
    );

    const payload = {
      references: this.references,
      link: this.link,
      id: this.id,
      long_url: this.longUrl,
      title: this.title,
      archived: this.archived,
      created_at: this.createdAt,
      created_by: this.createdBy,
      client_id: this.clientId,
      custom_bitlinks: this.customBitlinks,
      launchpad_ids: this.launchpadIds,
      is_deleted: this.isDeleted,
    };

    tags?.length && (payload.tags = tags);
    updatedDeepLink?.length && (payload.deeplinks = updatedDeepLink);
    const response = await this.bitly.updateBitlink(bitlink, payload);
    response && $.export("$summary", "Bitlink updated successfully");
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Bitly	`bitly`	`app`	This component uses the Bitly app.
Bitlink	`bitlink`	`string`	A Bitlink made of the domain and hash
References	`references`	`object`	Bitlink references
Link	`link`	`string`	Complete bitlink url
ID	`id`	`string`	Bitlink ID
Long Url	`longUrl`	`string`	Url that was shortened
Bitlink Title	`title`	`string`	Bitlink title
Bitlink Archived	`archived`	`boolean`	Archived bitlink (true or false)
Created At	`createdAt`	`string`	Bitlink created date. Example: 2006-03-12T16:29:46+0000
Created By	`createdBy`	`string`	Bitlink created_by ID
Client ID	`clientId`	`string`	Bitlink client ID
Custom Bitlinks	`customBitlinks`	`string[]`	Provide an array of custom bitlinks Example: `[ "https://microsoft.com/documentation", "https://github.com/contact", "https://gitlab.com/forum", "https://pipedream.com/chat ]`
Tags	`tags`	`string[]`	Enter array of tags
Launchpad IDs	`launchpadIds`	`string[]`	Enter array of Launchpad IDs
Deeplinks	`deeplinks`	`string[]`	Provide an object. Each object should represent a row. Example: { "guid": "Ra1bcD2eF3h", "bitlink": "bit.ly/documentation", "app_uri_path": "/store?id': '123456", "install_url": "https://play.google.com/store/apps/details?id=com.bitly.app', "app_guid": "Ab1cdE2fG3h", "os": "android", "install_type": "promote_install", "created": "2011-10-05T14:48:00.000Z", "modified": "2011-10-06T14:48:00.000Z" "brand_guid": "Ba1bc23dE4F" }
Is Deleted	`isDeleted`	`boolean`	Bitlink deleted (true or false)

Action Authentication#

Bitly uses OAuth authentication. When you connect your Bitly account, Pipedream will open a popup window where you can sign into Bitly and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Bitly API.

Pipedream requests the following authorization scopes when you connect your account: