Create Message with Vitally API on New Link from Rebrandly API

Pipedream makes it easy to connect APIs for Vitally, Rebrandly and 2,400+ other apps remarkably fast.

Trigger workflow on

New Link from the Rebrandly API

Next, do this

Create Message with the Vitally 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 Rebrandly trigger and Vitally action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Link trigger
1. Connect your Rebrandly account
2. Configure timer
Configure the Create Message action
1. Connect your Vitally account
2. Select a Organization Id
3. Select a Conversation Id
4. Configure External Id
5. Optional- Configure Timestamp
6. Configure Message
7. Select a From
8. Select one or more To
9. Optional- Select one or more CC
10. Optional- Select one or more BCC
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 Link on Rebrandly

Description:Emit new event on each new link created.

Version:0.0.3

Key:rebrandly-new-link

View on GitHub

Rebrandly Overview#

The Rebrandly API enables the creation, updating, and management of branded short links. Within Pipedream, you can leverage this API to automate custom URL shortening workflows, analyze link performance, and seamlessly integrate URL management into your business processes or applications.

Trigger Code#

import rebrandly from "../../rebrandly.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  name: "New Link",
  version: "0.0.3",
  key: "rebrandly-new-link",
  description: "Emit new event on each new link created.",
  type: "source",
  dedupe: "unique",
  props: {
    rebrandly,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      static: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  methods: {
    emitEvent(data) {
      this._setLastLinkId(data.id);

      this.$emit(data, {
        id: data.id,
        summary: `New link with id ${data.id}`,
        ts: Date.parse(data.createdAt),
      });
    },
    _setLastLinkId(id) {
      this.db.set("lastLinkId", id);
    },
    _getLastLinkId() {
      return this.db.get("lastLinkId");
    },
  },
  hooks: {
    async deploy() {
      const links = await this.rebrandly.getLinks({
        params: {
          limit: 10,
          orderBy: "createdAt",
          orderDir: "asc",
        },
      });

      links.forEach(this.emitEvent);
    },
  },
  async run() {
    const lastLinkId = this._getLastLinkId();

    while (true) {
      const links = await this.rebrandly.getLinks({
        params: {
          last: lastLinkId,
          orderBy: "createdAt",
          orderDir: "asc",
        },
      });

      links.forEach(this.emitEvent);

      if (links.length < 25) {
        return;
      }
    }
  },
};

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
Rebrandly	`rebrandly`	`app`	This component uses the Rebrandly app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

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

rbapi offline_access

About Rebrandly#

Custom URL Shortener

Action#

Create Message on Vitally

Description:Create a new message. [See the documentation](https://docs.vitally.io/pushing-data-to-vitally/rest-api/messages#create-a-message-post)

Version:0.0.2

Key:vitally-create-message

View on GitHub

Vitally Overview#

The Vitally API offers a window into customer success operations, enabling you to automate workflows, integrate with other tools, and manipulate customer data programmatically. With Pipedream, you can harness this API to create custom automations that react to events in Vitally, sync data between Vitally and other platforms, or maintain up-to-date customer profiles across your business stack.

Action Code#

import vitally from "../../vitally.app.mjs";

export default {
  key: "vitally-create-message",
  name: "Create Message",
  version: "0.0.2",
  description: "Create a new message. [See the documentation](https://docs.vitally.io/pushing-data-to-vitally/rest-api/messages#create-a-message-post)",
  type: "action",
  props: {
    vitally,
    organizationId: {
      propDefinition: [
        vitally,
        "organizationId",
      ],
    },
    conversationId: {
      propDefinition: [
        vitally,
        "conversationId",
        ({ organizationId }) => ({
          organizationId,
        }),
      ],
    },
    externalId: {
      propDefinition: [
        vitally,
        "externalId",
      ],
      description: "The unique ID of the message in your system.",
    },
    timestamp: {
      type: "string",
      label: "Timestamp",
      description: "The ISO-formatted string timestamp of when the message was sent.",
      optional: true,
    },
    message: {
      type: "string",
      label: "Message",
      description: "The HTML content of the message.",
    },
    from: {
      propDefinition: [
        vitally,
        "assignedToId",
        ({ organizationId }) => ({
          organizationId,
        }),
      ],
      label: "From",
      description: "The sender participant.",
    },
    to: {
      propDefinition: [
        vitally,
        "assignedToId",
      ],
      type: "string[]",
      label: "To",
      description: "List of the recipient participants.",
    },
    cc: {
      propDefinition: [
        vitally,
        "assignedToId",
      ],
      type: "string[]",
      label: "CC",
      description: "List of the cc recipient participants.",
      optional: true,
    },
    bcc: {
      propDefinition: [
        vitally,
        "assignedToId",
      ],
      type: "string[]",
      label: "BCC",
      description: "List of the bcc recipient participants.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      vitally,
      organizationId,
      conversationId,
      from,
      to,
      cc,
      bcc,
      ...data
    } = this;

    const response = await vitally.createMessage({
      $,
      organizationId,
      conversationId,
      data: {
        ...data,
        from: {
          type: "user",
          id: from,
        },
        to: to && to.map((id) => ({
          type: "user",
          id,
        })),
        cc: cc && cc.map((id) => ({
          type: "user",
          id,
        })),
        bcc: bcc && bcc.map((id) => ({
          type: "user",
          id,
        })),
      },
    });

    $.export("$summary", `A new message with Id: ${response.id} was successfully created!`);
    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
Vitally	`vitally`	`app`	This component uses the Vitally app.
Organization Id	`organizationId`	`string`	Select a value from the drop down menu.
Conversation Id	`conversationId`	`string`	Select a value from the drop down menu.
External Id	`externalId`	`string`	The unique ID of the message in your system.
Timestamp	`timestamp`	`string`	The ISO-formatted string timestamp of when the message was sent.
Message	`message`	`string`	The HTML content of the message.
From	`from`	`string`	Select a value from the drop down menu.
To	`to`	`string[]`	Select a value from the drop down menu.
CC	`cc`	`string[]`	Select a value from the drop down menu.
BCC	`bcc`	`string[]`	Select a value from the drop down menu.

Action Authentication#

Vitally uses API keys for authentication. When you connect your Vitally account, Pipedream securely stores the keys so you can easily authenticate to Vitally APIs in both code and no-code steps.

To retrieve your API Key,