Add Tags to Campaign with Instantly API on New Customer from LiveAgent API

Pipedream makes it easy to connect APIs for Instantly, LiveAgent and 2,500+ other apps remarkably fast.

Trigger workflow on

New Customer from the LiveAgent API

Next, do this

Add Tags to Campaign with the Instantly 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 LiveAgent trigger and Instantly action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Customer trigger
1. Connect your LiveAgent account
2. Configure timer
Configure the Add Tags to Campaign action
1. Connect your Instantly account
2. Select one or more Campaign ID
3. Select one or more Tags ID
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 Customer on LiveAgent

Description:Emit new event on each new customer.

Version:0.0.2

Key:liveagent-new-customer

View on GitHub

LiveAgent Overview#

The LiveAgent API provides access to a feature-rich helpdesk platform, allowing you to automate customer support tasks, synchronize data with other services, and streamline communication channels. With Pipedream, you can tap into the LiveAgent API to create custom workflows that enhance support operations, trigger actions based on customer interactions, and connect with a myriad of other apps to enrich the support ecosystem. Pipedream's serverless platform makes it simple to set up these automations with minimal coding, using pre-built actions or scripting your own.

Trigger Code#

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

export default {
  name: "New Customer",
  version: "0.0.2",
  key: "liveagent-new-customer",
  description: "Emit new event on each new customer.",
  type: "source",
  dedupe: "unique",
  props: {
    liveagent,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      static: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  methods: {
    emitEvent(data) {
      this.$emit(data, {
        id: data.id,
        summary: `New customer with id ${data.id}`,
        ts: Date.parse(data.date_created),
      });
    },
    _setLastTimestamp(timestamp) {
      this.db.set("lastTimestamp", timestamp);
    },
    _getLastTimestamp() {
      return this.db.get("lastTimestamp");
    },
  },
  hooks: {
    async deploy() {
      const customers = await this.liveagent.getCustomers({
        params: {
          _perPage: 20,
          _sortDir: "DESC",
          _sortField: "date_created",
        },
      });

      if (customers.length) {
        this._setLastTimestamp(Date.parse(customers[0].date_created));
      }

      customers.reverse().forEach(this.emitEvent);
    },
  },
  async run() {
    const lastTimestamp = this._getLastTimestamp();
    this._setLastTimestamp(new Date().getTime());

    let page = 1;

    while (true) {
      const customers = await this.liveagent.getCustomers({
        params: {
          _page: page,
          _perPage: 100,
          _sortDir: "DESC",
          _sortField: "date_created",
        },
      });

      customers.reverse().forEach(this.emitEvent);

      if (customers.length < 100 || Date.parse(customers[0].date_created) < +lastTimestamp) {
        return;
      }

      if (customers.length) {
        this._setLastTimestamp(Date.parse(customers[0].date_created));
      }

      page++;
    }

  },
};

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

Trigger Authentication#

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

You can find your API Key in Configuration > System > API in your LiveAgent account.
Your domain is 12345678 if your Live Agent URL is https://12345678.ladesk.com/

About LiveAgent#

LiveAgent is a web-based live chat and helpdesk software. It covers all support channels: Email, Live Chat, Call Center, Contact forms, Feedback Forms, Knowledge Base, Social networks(Twitter and Facebook) and integrates them into one enviroment.

Action#

Add Tags to Campaign on Instantly

Description:Adds tags to a specific campaign. [See the documentation](https://developer.instantly.ai/api/v2/customtag/toggletagresource)

Version:0.0.2

Key:instantly-add-tags-campaign

View on GitHub

Action Code#

import { parseObject } from "../../common/utils.mjs";
import instantly from "../../instantly.app.mjs";

export default {
  key: "instantly-add-tags-campaign",
  name: "Add Tags to Campaign",
  description: "Adds tags to a specific campaign. [See the documentation](https://developer.instantly.ai/api/v2/customtag/toggletagresource)",
  version: "0.0.2",
  type: "action",
  props: {
    instantly,
    campaignIds: {
      propDefinition: [
        instantly,
        "campaignId",
      ],
      type: "string[]",
      description: "The campaign IDs to assign tags to",
    },
    tagIds: {
      propDefinition: [
        instantly,
        "tagIds",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.instantly.addTagsToCampaign({
      $,
      data: {
        campaign_id: this.campaignId,
        tag_ids: parseObject(this.tagIds),
        resource_type: 2,
        assign: true,
        resource_ids: parseObject(this.campaignIds),
      },
    });
    $.export("$summary", "Successfully added tags to campaign(s)");
    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
Instantly	`instantly`	`app`	This component uses the Instantly app.
Campaign ID	`campaignIds`	`string[]`	Select a value from the drop down menu.
Tags ID	`tagIds`	`string[]`	Select a value from the drop down menu.