Skip to contentSkip to navigationSkip to topbar
On this page
Looking for more inspiration?Visit the
(information)
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.

Autopilot Source


Source Info
  • The Autopilot Source is an Event Cloud source. This means that it sends data as events, which are behaviors or occurrences tied to a user and a point in time. Data from these sources can be loaded into your Segment warehouses, and also sent to Segment streaming destinations. Learn more about cloud sources.
(warning)

This Source is supported in US data processing regions.

This Source is only supported in workspaces configured to process data in the US region. Workspaces configured with data processing regions outside of the US cannot connect to this source. For more information, see Regional Segment.

Autopilot(link takes you to an external page) makes automating customer journeys as simple as drawing on a whiteboard. Engage at just the right time with personalized emails, in-app messages, SMS, and postcards.

Take your company's email analysis to the next level by adding Autopilot as a Source to Segment. Segment automatically collects email events like Email Delivered and Email Opened, forwards them to your destinations, and loads them into your data warehouse.

This source is maintained by Autopilot. For any issues with the source, contact the AutopilotHQ Support team.


Getting started

getting-started page anchor
  1. From your Segment UI's Sources page click Add Source.
  2. Search for and select AutopilotHQ in the Sources Catalog and click Add Source to confirm.
  3. Give the Source a name and add any labels to help you organize and filter your sources. You can give the source any name, but Segment recommends a name that reflects the source itself, as this name autopopulates the schema name. For example, the source name AutopilotHQ creates the schema autopilothq.
  4. Sign in to your Autopilot account and visit the Segment destination(link takes you to an external page) to connect.

Stream

Autopilot uses our stream Source component to send events to Segment. These events are then available in any Destination that accepts server-side events, including your data warehouse.


The following table lists events that Autopilot sends to Segment. These events will show up as tables in your warehouse, and as regular events in your other Destinations.

Autopilot will send the userID if the contact has passed through the system before using Segment; otherwise Autopilot will send the email of the contact through as anonymousID.

Additionally, Autopilot also sends email and contact_id under context.traits.

Event nameDescription
Email BouncedReceiving server could not or would not accept message
Email DeliveredMessage has been successfully delivered to the receiving server
Email ClickedRecipient clicked on a link within the message
Email Marked as SpamRecipient marked message as spam
Email OpenedRecipient has opened the HTML message
Email UnsubscribedRecipient clicked on message's subscription management link
Email RepliedRecipient replied to the message

The following table outlines the properties included in the events.

Property nameDescription
eventThe email event type
campaign_idThe ID of the journey
campaign_nameThe name of the journey
email_idThe ID of the email
email_subjectThe subject line of the email
transactionalDefines the email as transactional or a one time send
link_idThe ID of the link clicked in an email
link_urlThe URL of the link clicked in an email

Now that your source is set up, you can connect it to Destinations.

Log in to your downstream tools and check to see that your events are populating and they contains all the properties you expect. If all your events and properties are not showing up, refer to the destination docs for troubleshooting.

If you experience any issues with how the events arrive in Segment, contact the Autopilot team.


Sending data to AutopilotHQ

sending-data-to-autopilothq page anchor

The AutopilotHQ Source works better when you also connect AutopilotHQ as a destination. With the AutopilotHQ destination, you can use Segment to send Identify and Track calls to AutopilotHQ. To start sending website, mobile or server data TO AutopilotHQ, see the AutopilotHQ destination docs.