ExploreTemplatesDocsChangelogPricingBlogCommunityPartners
Sign in
Sign up
← Zendesk + Help Scout integrations

Create Customer with Help Scout API on New Ticket Added to View (Instant) from Zendesk API

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

Trigger workflow on
New Ticket Added to View (Instant) from the Zendesk API
Next, do this
Create Customer with the Help Scout API
No credit card required
Intro to Pipedream
▶
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers ♥ Pipedream

Getting Started

This integration creates a workflow with a Zendesk trigger and Help Scout action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Select this integration
  2. Configure the New Ticket Added to View (Instant) trigger
    1. Connect your Zendesk account
    2. Select a Trigger Category ID
    3. Optional- Configure Custom Subdomain
    4. Optional- Select one or more Fields
    5. Optional- Configure JSON Body
    6. Select a View ID
  3. 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
  4. Deploy the workflow
  5. Send a test event to validate your setup
  6. 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 Ticket Added to View (Instant) on Zendesk
Description:Emit new event when a ticket is added to the specified view
Version:0.0.2
Key:zendesk-ticket-added-to-view

Zendesk Overview

The Zendesk API enables seamless integration of Zendesk's customer service platform with your existing business processes and third-party applications. By leveraging this API with Pipedream, you can automate ticket tracking, sync customer data, escalate issues, and streamline communication across multiple channels. This can significantly increase efficiency, accelerate response times, and enhance the overall customer experience. Automations can range from simple notifications to complex workflows involving data transformation and multi-step actions across various services.

Trigger Code

import common from "../common/ticket.mjs";

export default {
  ...common,
  key: "zendesk-ticket-added-to-view",
  name: "New Ticket Added to View (Instant)",
  description: "Emit new event when a ticket is added to the specified view",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    viewId: {
      propDefinition: [
        common.props.app,
        "viewId",
      ],
    },
  },
  methods: {
    ...common.methods,
    getWebhookName() {
      return "Ticket Added To View Webhook";
    },
    getTriggerTitle() {
      return "Ticket Added To View Trigger";
    },
    getTriggerConditions() {
      return {
        any: [
          {
            field: "update_type",
            value: "Change",
          },
          {
            field: "update_type",
            value: "Create",
          },
        ],
      };
    },
    async isRelevant(payload) {
      const { tickets } = await this.app.listTicketsInView({
        viewId: this.viewId,
      });
      const foundTicket = tickets.find(({ id }) => id == payload.ticketId);
      return foundTicket;
    },
  },
};

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.
LabelPropTypeDescription
ZendeskappappThis component uses the Zendesk app.
N/Adb$.service.dbThis component uses $.service.db to maintain state between executions.
N/Ahttp$.interface.httpThis 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.
Trigger Category IDcategoryIdstringSelect a value from the drop down menu.
Custom SubdomaincustomSubdomainstring

For Enterprise Zendesk accounts: optionally specify the subdomain to use. This will override the subdomain that was provided when connecting your Zendesk account to Pipedream. For example, if you Zendesk URL is https://examplehelp.zendesk.com, your subdomain is examplehelp

Fieldsfieldsstring[]Select a value from the drop down menu.
JSON BodyjsonBodystring

Custom JSON Body of the incoming payload. Setting jsonBody will overwrite the fields prop

View IDviewIdstringSelect a value from the drop down menu.

Trigger Authentication

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

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

triggers:writewebhooks:writereadtickets:writetickets:readusers:writeorganizations:readorganizations:write

About Zendesk

Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.

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

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.

LabelPropTypeDescription
Help ScouthelpScoutappThis component uses the Help Scout app.
First NamefirstNamestring

First name of the customer. When defined it must be between 1 and 40 characters.

Last NamelastNamestring

Last name of the customer. When defined it must be between 1 and 40 characters.

Phonephonestring

The phone number that will be used when creating a new customer.

Photo URLphotoUrlstring

URL of the customer's photo. Max length 200 characters.

Job TitlejobTitlestring

Job title. Max length 60 characters.

Photo TypephotoTypestringSelect a value from the drop down menu:unknowngravatartwitterfacebookgoogleprofilegooglepluslinkedininstagram
Backgroundbackgroundstring

This is the Notes field from the user interface. Max length 200 characters.

Locationlocationstring

Location of the customer. Max length 60 characters.

Organizationorganizationstring

Organization. Max length 60 characters.

GendergenderstringSelect a value from the drop down menu:malefemaleunknown
Ageagestring

Customer's age.

Emailsemailsstring[]

List of email entries. Format: {"type":"home","value":"customer@email.com"}. see Create Email for the object documentation.

Phonesphonesstring[]

List of phone entries. Format: {"type":"work","value":"222-333-4444"}. see Create Phone for the object documentation.

Chatschatsstring[]

List of chat entries. Format: {"type":"aim","value":"jsprout"}. see Create Chat Handle for the object documentation.

Social ProfilessocialProfilesstring[]

List of social profile entries. Format: {"type":"googleplus","value":"https://api.helpscout.net/+HelpscoutNet"}. see Create Social Profile for the object documentation.

Websiteswebsitesstring[]

List of websites entries. Format: {"value":"https://api.helpscout.net/"}. see Create Website for the object documentation.

Address CityaddressCitystring

The city of the customer.

Address StateaddressStatestring

The state of the customer.

Address Postal CodeaddressPostalCodestring

The postal code of the customer.

Address CountryaddressCountrystring

The ISO 3166 Alpha-2 code country of the customer.

Address LinesaddressLinesstring[]

A list of address lines.

Propertiespropertiesstring[]

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:

About Help Scout

Simple Customer Service Software and Education

More Ways to Connect Help Scout + Zendesk

Other Popular Integrations

Create Customer with Help Scout API on New Ticket (Instant) from Zendesk API
Zendesk + Help Scout
 
Try it
Create Customer with Help Scout API on Ticket Closed (Instant) from Zendesk API
Zendesk + Help Scout
 
Try it
Create Customer with Help Scout API on Ticket Pending (Instant) from Zendesk API
Zendesk + Help Scout
 
Try it
Create Customer with Help Scout API on Ticket Solved (Instant) from Zendesk API
Zendesk + Help Scout
 
Try it
Create Customer with Help Scout API on Ticket Updated (Instant) from Zendesk API
Zendesk + Help Scout
 
Try it

Popular Triggers

New Ticket (Instant) from the Zendesk API

Emit new event when a ticket is created

 
Try it
New Ticket Added to View (Instant) from the Zendesk API

Emit new event when a ticket is added to the specified view

 
Try it
Ticket Closed (Instant) from the Zendesk API

Emit new event when a ticket has changed to closed status

 
Try it
Ticket Pending (Instant) from the Zendesk API

Emit new event when a ticket has changed to pending status

 
Try it
Ticket Solved (Instant) from the Zendesk API

Emit new event when a ticket has changed to solved status

 
Try it

Popular Actions

Create Ticket with the Zendesk API

Creates a ticket. See the documentation.

 
Try it
Delete Ticket with the Zendesk API

Deletes a ticket. See the documentation.

 
Try it
Update Ticket with the Zendesk API

Updates a ticket. See the documentation.

 
Try it
Add Note to Conversation with the Help Scout API

Adds a note to an existing conversation in Help Scout. See the documentation

 
Try it
Create Customer with the Help Scout API

Creates a new customer record in Help Scout. See the documentation

 
Try it

Explore Other Apps

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

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
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.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.
abcdefghijklmnopqrstuvwxyz#
Pipedream, Inc. — San Francisco, CA
AboutTwitterDocsCommunityTermsPrivacy