Create Customer with Help Scout API on New Events (Instant) from Twilio SendGrid API

Pipedream makes it easy to connect APIs for Help Scout, Twilio SendGrid and 2,400+ other apps remarkably fast.

Trigger workflow on

New Events (Instant) from the Twilio SendGrid API

Next, do this

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

Select this integration
Configure the New Events (Instant) trigger
1. Connect your Twilio SendGrid account
2. Select one or more Event Types
Configure the Create Customer action
1. Connect your Help Scout account
2. Optional- Configure First Name
3. Optional- Configure Last Name
4. Optional- Configure Phone
5. Optional- Configure Photo URL
6. Optional- Configure Job Title
7. Optional- Select a Photo Type
8. Optional- Configure Background
9. Optional- Configure Location
10. Optional- Configure Organization
11. Optional- Select a Gender
12. Optional- Configure Age
13. Optional- Configure Emails
14. Optional- Configure Phones
15. Optional- Configure Chats
16. Optional- Configure Social Profiles
17. Optional- Configure Websites
18. Optional- Configure Address City
19. Optional- Configure Address State
20. Optional- Configure Address Postal Code
21. Optional- Configure Address Country
22. Optional- Configure Address Lines
23. Optional- Configure Properties
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 Events (Instant) on Twilio SendGrid

Description:Emit new event when any of the specified SendGrid events is received

Version:0.0.5

Key:sendgrid-events

View on GitHub

Twilio SendGrid Overview#

The Twilio SendGrid API opens up a world of possibilities for email automation, enabling you to send emails efficiently and track their performance. With this API, you can programmatically create and send personalized email campaigns, manage contacts, and parse inbound emails for data extraction. When you harness the power of Pipedream, you can connect SendGrid to hundreds of other apps to automate workflows, such as triggering email notifications based on specific actions, syncing email stats with your analytics, or handling incoming emails to create tasks or tickets.

Trigger Code#

import common from "../common/http-based.mjs";
import deliveryEventTypes from "./delivery-event-types.mjs";
import engagementEventTypes from "./engagement-event-types.mjs";

export default {
  ...common,
  key: "sendgrid-events",
  name: "New Events (Instant)",
  description: "Emit new event when any of the specified SendGrid events is received",
  version: "0.0.5",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    eventTypes: {
      type: "string[]",
      label: "Event Types",
      description: "The type of events to listen to",
      options(context) {
        const { page } = context;
        if (page !== 0) {
          return {
            options: [],
          };
        }

        const options = [
          ...deliveryEventTypes,
          ...engagementEventTypes,
        ];
        return {
          options,
        };
      },
    },
  },
  methods: {
    ...common.methods,
    baseWebhookSettings() {
      // The list of events that a webhook can listen to. This method returns an
      // exhaustive list of all such flags disabled, and each event source can
      // then override the flags that are relevant to the event they handle.
      //
      // See the docs for more information:
      // https://sendgrid.com/docs/api-reference/
      const eventTypesData = [
        ...deliveryEventTypes,
        ...engagementEventTypes,
      ];
      return eventTypesData.reduce((accum, eventTypeData) => ({
        ...accum,
        [eventTypeData.value]: false,
      }), {});
    },
    webhookEventFlags() {
      return this.eventTypes.reduce((accum, eventType) => ({
        ...accum,
        [eventType]: true,
      }), {});
    },
    generateMeta(data) {
      const {
        event: eventType,
        sg_event_id: id,
        timestamp: ts,
      } = data;
      const summary = `New event: ${eventType}`;
      return {
        id,
        summary,
        ts,
      };
    },
  },
};

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.
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid 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.
Event Types	`eventTypes`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

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

About Twilio SendGrid#

Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.

Action#

Create Customer on Help Scout

Description:Creates a new customer record in Help Scout. [See the documentation](https://developer.helpscout.com/mailbox-api/endpoints/customers/create/)

Version:0.0.1

Key:help_scout-create-customer

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.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import {
  GENDER_OPTIONS,
  PHOTO_TYPE_OPTIONS,
} from "../../common/constants.mjs";
import {
  cleanObject,
  parseObject,
} from "../../common/utils.mjs";
import helpScout from "../../help_scout.app.mjs";

export default {
  key: "help_scout-create-customer",
  name: "Create Customer",
  description: "Creates a new customer record in Help Scout. [See the documentation](https://developer.helpscout.com/mailbox-api/endpoints/customers/create/)",
  version: "0.0.1",
  type: "action",
  props: {
    helpScout,
    firstName: {
      type: "string",
      label: "First Name",
      description: "First name of the customer. When defined it must be between 1 and 40 characters.",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Last name of the customer. When defined it must be between 1 and 40 characters.",
      optional: true,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "The phone number that will be used when creating a new customer.",
      optional: true,
    },
    photoUrl: {
      type: "string",
      label: "Photo URL",
      description: "URL of the customer's photo. Max length 200 characters.",
      optional: true,
    },
    jobTitle: {
      type: "string",
      label: "Job Title",
      description: "Job title. Max length 60 characters.",
      optional: true,
    },
    photoType: {
      type: "string",
      label: "Photo Type",
      description: "The type of photo.",
      options: PHOTO_TYPE_OPTIONS,
      optional: true,
    },
    background: {
      type: "string",
      label: "Background",
      description: "This is the Notes field from the user interface. Max length 200 characters.",
      optional: true,
    },
    location: {
      type: "string",
      label: "Location",
      description: "Location of the customer. Max length 60 characters.",
      optional: true,
    },
    organization: {
      type: "string",
      label: "Organization",
      description: "Organization. Max length 60 characters.",
      optional: true,
    },
    gender: {
      type: "string",
      label: "Gender",
      description: "Gender of this customer.",
      options: GENDER_OPTIONS,
      optional: true,
    },
    age: {
      type: "string",
      label: "Age",
      description: "Customer's age.",
      optional: true,
    },
    emails: {
      type: "string[]",
      label: "Emails",
      description: "List of email entries. **Format: {\"type\":\"home\",\"value\":\"customer@email.com\"}**. see [Create Email](https://developer.helpscout.com/mailbox-api/endpoints/customers/emails/create) for the object documentation.",
      optional: true,
    },
    phones: {
      type: "string[]",
      label: "Phones",
      description: "List of phone entries. **Format: {\"type\":\"work\",\"value\":\"222-333-4444\"}**. see [Create Phone](https://developer.helpscout.com/mailbox-api/endpoints/customers/phones/create) for the object documentation.",
      optional: true,
    },
    chats: {
      type: "string[]",
      label: "Chats",
      description: "List of chat entries. **Format: {\"type\":\"aim\",\"value\":\"jsprout\"}**. see [Create Chat Handle](https://developer.helpscout.com/mailbox-api/endpoints/customers/chat_handles/create) for the object documentation.",
      optional: true,
    },
    socialProfiles: {
      type: "string[]",
      label: "Social Profiles",
      description: "List of social profile entries. **Format: {\"type\":\"googleplus\",\"value\":\"https://api.helpscout.net/+HelpscoutNet\"}**. see [Create Social Profile](https://developer.helpscout.com/mailbox-api/endpoints/customers/social_profiles/create) for the object documentation.",
      optional: true,
    },
    websites: {
      type: "string[]",
      label: "Websites",
      description: "List of websites entries. **Format: {\"value\":\"https://api.helpscout.net/\"}**. see [Create Website](https://developer.helpscout.com/mailbox-api/endpoints/customers/websites/create) for the object documentation.",
      optional: true,
    },
    addressCity: {
      type: "string",
      label: "Address City",
      description: "The city of the customer.",
      optional: true,
    },
    addressState: {
      type: "string",
      label: "Address State",
      description: "The state of the customer.",
      optional: true,
    },
    addressPostalCode: {
      type: "string",
      label: "Address Postal Code",
      description: "The postal code of the customer.",
      optional: true,
    },
    addressCountry: {
      type: "string",
      label: "Address Country",
      description: "The [ISO 3166 Alpha-2 code](https://www.iban.com/country-codes) country of the customer.",
      optional: true,
    },
    addressLines: {
      type: "string[]",
      label: "Address Lines",
      description: "A list of address lines.",
      optional: true,
    },
    properties: {
      type: "string[]",
      label: "Properties",
      description: "List of social profile entries. **Format: {\"type\":\"googleplus\",\"value\":\"https://api.helpscout.net/+HelpscoutNet\"}**. see [Create Social Profile](https://developer.helpscout.com/mailbox-api/endpoints/customers/social_profiles/create) for the object documentation.",
      optional: true,
    },
  },
  async run({ $ }) {
    const address = cleanObject({
      city: this.addressCity,
      state: this.addressState,
      postalCode: this.addressPostalCode,
      country: this.addressCountry,
      lines: parseObject(this.addressLines),
      properties: parseObject(this.properties),
    });

    let data = {};

    data = cleanObject({
      firstName: this.firstName,
      lastName: this.lastName,
      phone: this.phone,
      photoUrl: this.photoUrl,
      jobTitle: this.jobTitle,
      photoType: this.photoType,
      background: this.background,
      location: this.location,
      organization: this.organization,
      gender: this.gender,
      age: this.age,
      emails: parseObject(this.emails),
      phones: parseObject(this.phones),
      chats: parseObject(this.chats),
      socialProfiles: parseObject(this.socialProfiles),
      websites: parseObject(this.websites),
    });

    if (Object.keys(address).length) data.address = address;

    if (!Object.keys(data).length) {
      throw new ConfigurationError("At least one field or customer entry must be defined.");
    }

    try {
      const response = await this.helpScout.createCustomer({
        $,
        data,
      });

      $.export("$summary", "Successfully created the new customer.");
      return response;
    } catch ({ message }) {
      const error = JSON.parse(message)._embedded.errors[0];
      throw new ConfigurationError(`Path: ${error.path} - ${error.message}`);
    }
  },
};

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
Help Scout	`helpScout`	`app`	This component uses the Help Scout app.
First Name	`firstName`	`string`	First name of the customer. When defined it must be between 1 and 40 characters.
Last Name	`lastName`	`string`	Last name of the customer. When defined it must be between 1 and 40 characters.
Phone	`phone`	`string`	The phone number that will be used when creating a new customer.
Photo URL	`photoUrl`	`string`	URL of the customer's photo. Max length 200 characters.
Job Title	`jobTitle`	`string`	Job title. Max length 60 characters.
Photo Type	`photoType`	`string`	Select a value from the drop down menu:`unknowngravatartwitterfacebookgoogleprofilegooglepluslinkedininstagram`
Background	`background`	`string`	This is the Notes field from the user interface. Max length 200 characters.
Location	`location`	`string`	Location of the customer. Max length 60 characters.
Organization	`organization`	`string`	Organization. Max length 60 characters.
Gender	`gender`	`string`	Select a value from the drop down menu:`malefemaleunknown`
Age	`age`	`string`	Customer's age.
Emails	`emails`	`string[]`	List of email entries. Format: {"type":"home","value":"customer@email.com"}. see Create Email for the object documentation.
Phones	`phones`	`string[]`	List of phone entries. Format: {"type":"work","value":"222-333-4444"}. see Create Phone for the object documentation.
Chats	`chats`	`string[]`	List of chat entries. Format: {"type":"aim","value":"jsprout"}. see Create Chat Handle for the object documentation.
Social Profiles	`socialProfiles`	`string[]`	List of social profile entries. Format: {"type":"googleplus","value":"https://api.helpscout.net/+HelpscoutNet"}. see Create Social Profile for the object documentation.
Websites	`websites`	`string[]`	List of websites entries. Format: {"value":"https://api.helpscout.net/"}. see Create Website for the object documentation.
Address City	`addressCity`	`string`	The city of the customer.
Address State	`addressState`	`string`	The state of the customer.
Address Postal Code	`addressPostalCode`	`string`	The postal code of the customer.
Address Country	`addressCountry`	`string`	The ISO 3166 Alpha-2 code country of the customer.
Address Lines	`addressLines`	`string[]`	A list of address lines.
Properties	`properties`	`string[]`	List of social profile entries. Format: {"type":"googleplus","value":"https://api.helpscout.net/+HelpscoutNet"}. see Create Social Profile for the object documentation.

Action 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:

Create Customer with Help Scout API on New Events (Instant) from Twilio SendGrid API

Pipedream makes it easy to connect APIs for Help Scout, Twilio SendGrid and 2,400+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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