Create Link with Short.io API on New Conversation Assigned (Instant) from Help Scout API

Pipedream makes it easy to connect APIs for Short.io, Help Scout and 2,700+ other apps remarkably fast.

Trigger workflow on

New Conversation Assigned (Instant) from the Help Scout API

Next, do this

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

Select this integration
Configure the New Conversation Assigned (Instant) trigger
1. Connect your Help Scout account
2. Optional- Configure Label
Configure the Create Link action
1. Connect your Short.io account
2. Select a Domain Id
3. Configure Original URL
4. Optional- Configure Path
5. Optional- Configure Title
6. Optional- Configure Tags
7. Optional- Configure Allow duplicates
8. Optional- Configure Expires at
9. Optional- Configure Expired URL
10. Optional- Configure iPhone URL
11. Optional- Configure Android URL
12. Optional- Configure password
13. Optional- Configure UTM Source
14. Optional- Configure UTM Medium
15. Optional- Configure UTM Campaign
16. Optional- Configure UTM Term
17. Optional- Configure UTM Content
18. Optional- Configure Cloaking
19. Optional- Select a Redirect type
20. Optional- Select a Folder 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 Conversation Assigned (Instant) on Help Scout

Description:Emit new event when a conversation is assigned to an agent. [See the documentation](https://developer.helpscout.com/)

Version:0.0.2

Key:help_scout-new-conversation-assigned-instant

View on GitHub

Help Scout Overview#

The Help Scout API provides programmatic access to customer support functionalities, allowing the automation of ticketing, customer communication, and reporting tasks. With this API, you can read and send messages, manage conversations, work with mailboxes, create and update customers’ information, and generate reports. Utilizing the API on Pipedream, you can automate workflows that respond to events in Help Scout in real-time, integrate customer support data with other business tools, and streamline support operations.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "help_scout-new-conversation-assigned-instant",
  name: "New Conversation Assigned (Instant)",
  description: "Emit new event when a conversation is assigned to an agent. [See the documentation](https://developer.helpscout.com/)",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getEventType() {
      return [
        "convo.assigned",
      ];
    },
    getSummary(body) {
      return `New conversation assigned to ${body.assignee.email}`;
    },
  },
  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
Help Scout	`helpScout`	`app`	This component uses the Help Scout 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.
Label	`label`	`string`	Label associated with this WebHook for better clarity.

Trigger Authentication#

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

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

About Help Scout#

Simple Customer Service Software and Education

Action#

Create Link on Short.io

Description:Create a Short Link. [See the documentation](https://developers.short.io/reference/linkspost).

Version:0.1.0

Key:short-create-a-link

View on GitHub

Short.io Overview#

Short.io provides a robust API for URL shortening, allowing you to create, delete, and track shortened links programmatically. By integrating with Pipedream, you can automate link creation or aggregation of click data in real-time, triggering workflows in response to events like link clicks or creating short links in bulk from a data source.

Action Code#

import shortApp from "../../short.app.mjs";
import common from "../common/common.mjs";
import lodash from "lodash";

const {
  props: { // eslint-disable-next-line no-unused-vars
    domain, ...props
  },
} = common;

export default {
  key: "short-create-a-link",
  name: "Create Link",
  description: "Create a Short Link. [See the documentation](https://developers.short.io/reference/linkspost).",
  version: "0.1.0",
  type: "action",
  props: {
    shortApp,
    domainId: {
      propDefinition: [
        shortApp,
        "domainId",
      ],
    },
    ...props,
    folderId: {
      propDefinition: [
        shortApp,
        "folderId",
        ({ domainId }) => ({
          domainId,
        }),
      ],
    },
  },
  async run({ $ }) {
    const param = lodash.pick(this, [
      "originalURL",
      "path",
      "title",
      "tags",
      "allowDuplicates",
      "expiresAt",
      "expiredURL",
      "iphoneURL",
      "androidURL",
      "password",
      "utmSource",
      "utmMedium",
      "utmCampaign",
      "utmTerm",
      "utmContent",
      "cloaking",
      "redirectType",
      "folderId",
    ]);
    const { hostname: domain } = await this.shortApp.getDomainInfo(this.domainId);
    const link = await this.shortApp.createLink($, {
      domain,
      ...param,
    });
    $.export("$summary", `Successfully created the link: ${link.secureShortURL}`);
    return link;
  },
};

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
Short.io	`shortApp`	`app`	This component uses the Short.io app.
Domain Id	`domainId`	`integer`	Select a value from the drop down menu.
Original URL	`originalURL`	`string`	Link, which you want to shorten.
Path	`path`	`string`	Optional path part of newly created link. If empty - it will be generated automatically.
Title	`title`	`string`	Title of created URL to be shown in short.io admin panel.
Tags	`tags`	`string[]`	Specify the tags of your link.
Allow duplicates	`allowDuplicates`	`boolean`	Specify whether to allow repeated links to be registered.
Expires at	`expiresAt`	`string`	Link expiration date, use `yyyy-mm-dd` format. If no expiration date is given (default), link will never expire.
Expired URL	`expiredURL`	`string`	URL to redirect when the link is expired.
iPhone URL	`iphoneURL`	`string`	If users open the URL with iPhone, they will be redirected to this URL.
Android URL	`androidURL`	`string`	If users open the URL with Android, they will be redirected to this URL
password	`password`	`string`	Requires Personal plan. Password to be asked when user visits a link. This password will not be stored in plain text, we will hash it with salt.
UTM Source	`utmSource`	`string`	The referrer: (e.g. google, newsletter).
UTM Medium	`utmMedium`	`string`	Marketing medium: (e.g. cpc, banner, email).
UTM Campaign	`utmCampaign`	`string`	Product, promo code, or slogan (e.g. spring_sale).
UTM Term	`utmTerm`	`string`	Identify the paid keywords.
UTM Content	`utmContent`	`string`	Use to differentiate ads.
Cloaking	`cloaking`	`boolean`	Specify whether to cloak the link.
Redirect type	`redirectType`	`integer`	Select a value from the drop down menu:`{ "label": "301 Moved Permanently", "value": 301 }{ "label": "302 Found", "value": 302 }{ "label": "303 See Other", "value": 303 }{ "label": "307 Temporary Redirect", "value": 307 }{ "label": "308 Permanent Redirect", "value": 308 }`
Folder ID	`folderId`	`string`	Select a value from the drop down menu.

Create Link with Short.io API on New Conversation Assigned (Instant) from Help Scout API

Pipedream makes it easy to connect APIs for Short.io, Help Scout and 2,700+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

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