Retrieve a Bitlink with Bitly API on New Attachment Received from Gmail API

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

Trigger workflow on

New Attachment Received from the Gmail API

Next, do this

Retrieve a 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 Gmail 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 Attachment Received trigger
1. Configure timer
2. Connect your Gmail account
3. Optional- Configure Search Query
4. Optional- Select one or more Labels
Configure the Retrieve a Bitlink action
1. Connect your Bitly account
2. Configure Bitlink url
3. Configure Create new Bitlink if not found?
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 Attachment Received on Gmail

Description:Emit new event for each attachment in a message received. This source is capped at 100 max new messages per run.

Version:0.0.5

Key:gmail-new-attachment-received

View on GitHub

Gmail Overview#

By connecting your personal Gmail account to Pipedream, you'll be able to incorporate email into whatever you're building with any of the thousands of apps that are available on Pipedream.

Trigger Code#

import gmail from "../../gmail.app.mjs";
import common from "../common/polling-messages.mjs";

export default {
  ...common,
  key: "gmail-new-attachment-received",
  name: "New Attachment Received",
  description: "Emit new event for each attachment in a message received. This source is capped at 100 max new messages per run.",
  version: "0.0.5",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    gmail,
    q: {
      propDefinition: [
        gmail,
        "q",
      ],
    },
    labels: {
      propDefinition: [
        gmail,
        "label",
      ],
      type: "string[]",
      label: "Labels",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    constructQuery(lastDate) {
      const { q: query } = this;
      const hasAttachment = query?.includes("has:attachment")
        ? ""
        : "has:attachment";
      const after = !query?.includes("after:") && lastDate
        ? `after:${lastDate / 1000}`
        : "";
      return [
        hasAttachment,
        after,
        query,
      ].join(" ").trim();
    },
    getLabels() {
      return this.labels;
    },
    generateMeta(attachment, message) {
      return {
        id: `${message.id}${attachment.partId}`,
        summary: `New Attachment: ${attachment.filename}`,
        ts: +message.internalDate,
      };
    },
    emitEvent(message) {
      if (message) {
        const { parts: attachments } = message.payload;

        attachments.filter((attachment) => attachment.body.attachmentId).forEach((attachment) => {
          this.$emit({
            message,
            attachment,
          }, this.generateMeta(attachment, message));
        });
      }
    },
  },
};

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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Gmail	`gmail`	`app`	This component uses the Gmail app.
Search Query	`q`	`string`	Apply a search filter using Gmail's standard search operators
Labels	`labels`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

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

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

emailprofileopenidhttps://www.googleapis.com/auth/gmail.labelshttps://www.googleapis.com/auth/gmail.sendhttps://www.googleapis.com/auth/gmail.modifyhttps://www.googleapis.com/auth/gmail.composehttps://www.googleapis.com/auth/gmail.settings.basic

About Gmail#

Gmail offers private and secure email by Google at no cost, for business and consumer accounts.

Action#

Retrieve a Bitlink on Bitly

Description:Finds an existing Bitlink in your account. Optionally, creates one if none are found. [See the docs here](https://dev.bitly.com/api-reference#expandBitlink)

Version:0.0.1

Key:bitly-find-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 { ConfigurationError } from "@pipedream/platform";
import { formatArrayStrings } from "../../common/utils.mjs";
import constants from "../../common/constants.mjs";
import bitly from "../../bitly.app.mjs";

export default {
  key: "bitly-find-bitlink",
  name: "Retrieve a Bitlink",
  description:
    "Finds an existing Bitlink in your account. Optionally, creates one if none are found.  [See the docs here](https://dev.bitly.com/api-reference#expandBitlink)",
  version: "0.0.1",
  type: "action",
  props: {
    bitly,
    bitlink: {
      type: "string",
      label: "Bitlink url",
      description: "This is the shortened url",
    },
    createBitlinkIfNotFound: {
      label: "Create new Bitlink if not found?",
      description:
        "Create a new bitlink if no record is found for the specified bitlink.",
      type: "boolean",
      default: false,
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {
      longUrl: {
        type: "string",
        label: "Long url",
        description: "This is the url to be shortened",
      },
      title: {
        type: "string",
        optional: true,
        label: "Bitlink title",
      },
      tags: {
        type: "string[]",
        optional: true,
        label: "Tags",
        description: "This is an array of strings",
      },
      domain: {
        type: "string",
        label: "Domain",
        description:
          "Bitlinks that contain deeplinks configured with a custom domain",
        optional: true,
      },
      groupGuid: {
        type: "string",
        optional: true,
        label: "Group guid",
      },
      deeplinks: {
        type: "string[]",
        optional: true,
        label: "Deeplinks",
        description: `Provide an object. Each object should represent a row.
        Example:
        \`{
          "app_id":"com.bitly.app",
          "app_uri_path": "/store?id=123456",
          "install_url": "https://play.google.com/store/apps/details?id=com.bitly.app&hl=en_US",
          "install_type": "promote_install"
        }\``,
      },
    };
    return this.createBitlinkIfNotFound && props;
  },
  async run({ $ }) {
    let bitlinkDetail;
    const {
      domain,
      title,
      tags,
      createBitlinkIfNotFound,
      deeplinks,
    } = this;
    try {
      bitlinkDetail = await this.bitly.getBitlink(this.bitlink);
    } catch (error) {
      if (createBitlinkIfNotFound) {
        $.export("$summary", "Bitlink not found. Creating new Bitlink");
      } else {
        throw new ConfigurationError("Bitlink not found");
      }
    }

    if (!bitlinkDetail && createBitlinkIfNotFound) {
      const payload = {
        long_url: this.longUrl,
        domain,
        group_guid: this.groupGuid,
        title,
      };
      const updatedDeepLink = formatArrayStrings(
        deeplinks,
        constants.ALLOWED_DEEPLINK_KEYS,
        "deeplinks",
      );

      tags?.length && (payload.tags = tags);
      updatedDeepLink?.length && (payload.deeplinks = updatedDeepLink);

      const response = await this.bitly.createBitlink(payload);
      response && $.export("$summary", "Bitlink created successfully");
      return response;
    }
    return bitlinkDetail;
  },
};

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 url	`bitlink`	`string`	This is the shortened url
Create new Bitlink if not found?	`createBitlinkIfNotFound`	`boolean`	Create a new bitlink if no record is found for the specified bitlink.

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:

About Bitly#

URL shortener

More Ways to Connect Bitly + Gmail#

Other Popular Integrations#

Shorten a Link with Bitly API on New Attachment Received from Gmail API

Gmail + Bitly

Retrieve a Bitlink with Bitly API on New Attachment Received from Gmail API

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

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

Developers ♥ Pipedream

1-24of2,200+apps by most popular

1
-
24
of
2,200+
apps by most popular