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 Destination


Destination Info
  • Accepts Identify and Track calls.
  • Refer to it as AutopilotHQ in the Integrations object

Autopilot(link takes you to an external page) helps thousands of organizations around the world automate their marketing with visual and simple customer journey marketing software.

This destination is maintained by Autopilot. See Autopilot's documentation(link takes you to an external page) for more information. For any issues with the destination, contact our friends at Autopilot(link takes you to an external page).

Are you instead trying to set up Autopilot as a Source to get data from Autopilot into your data warehouse or other downstream tools? See our documentation on our Autopilot source instead.


Getting Started

getting-started page anchor
  1. From the Segment web app, click Catalog.
  2. Search for "Autopilot" in the Catalog, select it, and choose which of your sources to connect the destination to.
  3. In the destination settings, enter your "API Key" from your Autopilot Segment Sync settings page(link takes you to an external page) or go to Autopilot: Settings -> App Connections -> Segment and copy/paste the API key which is listed there.
  4. Once enabled 'identify' and 'track' calls will be sent to Autopilot.

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:

1
analytics.identify('12091906-01011992', {
2
name: 'John Joe',
3
email: 'john.doe@example.com'
4
});
(information)

Engage requires Identify calls from the Autopilot destination to include email or userId

If neither are provided in the payload then the Autopilot destination's Event Delivery tab will show a 400 Bad Request error message : "Missing unique identifier traits. Either email or user_id traits must be provided".


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

1
analytics.track("Step Activated", {
2
property: "test"
3
});

Additional Autopilot Tracking code will be required on your site to unlock the following features:

  • Website activity for anonymous and known visitors ('page' calls).
  • Capturing form submissions.
  • Triggering Headsup messages.
  • User association using the Autopilot JavaScript library.

For complete details, visit the Autopilot page How to use Segment with Autopilot(link takes you to an external page).


You can send computed traits and audiences generated using Engage to this destination as a user property. To learn more about Engage, schedule a demo(link takes you to an external page).

For user-property destinations, an identify call is sent to the destination for each user being added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Engage sends an Identify call with the property order_completed_last_30days: true. When the user no longer satisfies this condition (for example, it's been more than 30 days since their last order), Engage sets that value to false.

When you first create an audience, Engage sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.

(information)

Real-time to batch destination sync frequency

Real-time audience syncs to Autopilot may take six or more hours for the initial sync to complete. Upon completion, a sync frequency of two to three hours is expected.


Segment lets you change these destination settings from the Segment app without having to touch any code.

Property nameTypeRequiredDescription
API Keystring
required

Get your API key from here(link takes you to an external page) or go to Autopilot: Settings -> App Connections -> Segment and copy/paste the API key which is listed there.