You're in the right place! Segment documentation is now part of Twilio Docs. The content you are used to is still here—just in a new home with a refreshed look.

Help Scout Destination

Destination Info

Accepts Identify calls.
Refer to it as Help Scout in the Integrations object

Components

Server

Connection Modes

Device-mode	Cloud-mode
❌ Web	✅ Web
❌ Mobile	✅ Mobile
❌ Server	✅ Server

Help Scout is a help desk software company which provides an email-based customer support platform, knowledge base tool, and an embeddable search/contact widget for customer service professionals.

Getting Started

From the Segment web app, click Catalog.
Search for Help Scout in the Catalog, select it, and choose which of your sources to connect the destination to.
Click "Connect to Help Scout" to start the Help Scout authentication process. Help Scout provides a secure token that Segment uses to send data to Help Scout. If you need to change accounts, click Disconnect, then connect to a new Help Scout account.
Enable the Destination.

(warning)

Help Scout OAuth supports one destination per user

Help Scout's OAuth connection to Segment supports one destination per user. If you try to create two destinations with the same user, you'll receive invalid token errors when you use the destination.

Identify

If you're not familiar with the Segment Specs, take a look to understand what the Identify method does. An example call would look like this:

1  analytics.identify({
2    userId: '019mr8mf4r',
3    traits: {
4      name: 'Kamala Khan',
5      email: 'kkhan@colesacademic.edu',
6    }
7  });

You can use the Identify call to create or update customers in your Help Scout account.

Help Scout requires a name and an email to complete the request. You can set the userId as the email, although this is not recommended. You can also specify firstName and lastName traits instead of a single name trait. You can learn more about which properties Help Scout accepts in their Create Customer documentation.

(information)

Info

This destination doesn't allow you to send custom properties to Help Scout. Use Destination Functions to send any non-standard properties to Help Scout.