Autopilot¶
Getting Started with Autopilot¶
The Autopilot modules allow you to monitor, create, retrieve, delete, update, search contacts and lists in your Autopilot account.
Prerequisites
- An Autopilot account
In order to use Autopilot with Ibexa Connect, it is necessary to have an Autopilot account. If you do not have one, you can create an Autopilot account at www.autopilothq.com/signup.
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting Autopilot to Ibexa Connect¶
To connect your Autopilot account to Ibexa Connect you need to get the API Key from the Autopilot account and insert it into the Ibexa Connect Autopilot module.
-
Log in to your Autopilot account.
-
Open the Settings page.
-
Open the Autopilot API settings.
-
Click the Generate button and copy the generated Autopilot API Key.
-
Go to Ibexa Connect and open the Create a connection dialog of the desired Autopilot module. Enter the copied API Key to the respective field.
-
Click Continue to establish the connection.
Triggers¶
Watch Events¶
Triggers when a contact is created, updated, unsubscribed, added to a list, removed from a list, entered to a segment, or has left a segment.
Webhook name |
Enter a name for the webhook. E.g. contact added |
|
Event |
Contact added Triggers when a contact is added to your Autopilot account: manually, using a spreadsheet import, a Salesforce sync, an API Call, a Zapier event, or a Segment.com event. Contact updated Triggers when a contact is modified: manually, by a spreadsheet import which includes new information, by a Salesforce sync which includes new information, by an API Call which adds details to contacts, when the contact unsubscribes, a Zapier event, a Segment.com event, or other Autopilot events which update contact information. Contact unsubscribed Triggers when a contact unsubscribes from emails: manually by unchecking the box in the contact profile, a Salesforce sync causes the unsubscribe field to be updated, a field update on a journey causes the contact to be unsubscribed, or the contact clicks an unsubscribe link in an email you send. Contact added to list Triggers when a contact is added to a list: manually using the contacts section of the Autopilot UI, in a journey which has a step that adds contacts to a list and the contact reaches it, by an API call, or by contact import. Contact removed from list Triggers when a contact is removed from a list: manually using the contacts section of the Autopilot UI, in a journey which a step that removes contacts from a list and the contact reaches it, or by an API call. Contact entered segment Triggers when a contact enters the segment by meeting the segment criteria. Contact left segment Triggers when a contact leaves the segment by no longer meeting the segment criteria |
Actions¶
Update Contact¶
Updates an existing contact.
Note
To clear the value from the field please use the keyword null from the General functions dialog.
Email address |
Enter the email address of the contact you want to update. |
||
New email |
Enter a new email address for the contact. | If you try to change a contact's email address to an email which already exists, you will receive a 409 Conflict error or in some cases a 500 error. |
First name
Enter the first name of the contact.
Last name
Enter the last name of the contact.
Enter the contact's Twitter account address.
Salutation
Enter the contact salutation.
Number of employees
Number of employees of the contact's company.
Company
Enter the name of the contact's company.
Title
Enter the job title.
Industry
Enter the company's industry
Phone
Enter the contact's phone number.
Mobile phone
Enter the contact's mobile phone number.
Fax
Enter the contact's fax number.
Website
Enter the contact's website.
Mailing address
Enter the mailing street, city, postal code, and country for the contact.
Owner name
Enter the owner of the lead.
Lead source
Enter the lead source.
Status
Enter the status of the contact.
Enter the contact's LinkedIn account address.
Unsubscribed
If the Yes option is selected, the email permission will be set to unsubscribed.
Session ID
Enter the session ID. If you're using Autopilot's Tracking Code, you can associate a visitor session to a contact with the Session ID contact field.
List
Enter the ID of the list you want to insert the contact to. E.g. contactlist_91053049-5582-40B4-A17F-78ADF8F25663
Note
If you copy the ID from the URL, add the contactlist_ before the ID itself (see the example above).
Use custom fields?
Select whether you want to use custom fields.
If you select the Yes option, then a custom field appears and you can fill in the desired value in the field.
Note
The custom fields must be already created using the Autopilot UI in order to display the field in the Ibexa Connect module.
Get Contact¶
Retrieves details of the selected contact.
| Contact ID or email | Select whether you want to choose the contact by email or contact ID. |
| Contact ID/Email | Select the ID or email you want to retrieve information about. |
Delete Contact¶
Deletes a contact.
| Contact ID or email | Select whether you want to choose the contact by email or contact ID. |
| Contact ID/Email | Select the ID or email you want to delete. |
Unsubscribe Contact¶
Unsubscribes the selected contact from receiving emails from your Autopilot Journeys.
| Contact ID or email | Select whether you want to choose the contact by email or contact ID. |
| Contact ID/Email | Select the ID or email you want to unsubscribe from receiving emails. |
Add List¶
Adds a new list. Lists are used in Autopilot to group contacts together. A contact can belong to as many lists as you like.
Note
If you specify a list name which already exists, a sequential number will be added to the end of the list name.
| List name | Enter the name for a new list. |
Check if Contact on List¶
Checks if a contact belongs to a specified list.
Note
If the operation fails with the error The operation failed with an error. Contact not on the list, the contact is not on the list.
| List ID | Select or map the list you want to check for the contact presence. |
| Contact ID or email | Select whether you want to choose the contact by email or by contact ID. |
| Contact ID/Email | Enter (map) the ID or email you want to check. |
Add Contact to List¶
Adds selected contact to a list.
List ID |
Select or map the list you want to add a contact to. |
||
Contact ID or email |
Select whether you want to choose the contact by email or contact ID. |
||
Contact ID/Email |
Select the ID or email you want to add to the list. | The contact must already exist! It is not possible to add a new email to the list. |
Note
If the person has no email, the name or contact ID will be displayed in the drop-down menu instead.
Remove Contact from List¶
Removes a contact from the list.
| List ID | Select or map the list you want to remove the contact from. |
| Contact ID or email | Select whether you want to choose the contact by email or contact ID. |
| Contact ID/Email | Select the ID or email you want to remove from the list. |
Get Email¶
Retrieves the data of an email campaign.
| Email ID | Enter the ID received in the Autopilot Activity Stream. |
Delete Contact Activity Feed¶
This method was added to help Autopilot customers comply with GDPR deletion requests. Calling this method with the contact ID or email address of the customer will result in their entire activity feed being deleted.
| Contact ID or email | Select whether you want to choose the contact by email or contact ID. |
| Contact ID/Email | Select the ID or email of whose activity feed you want to delete. |
| Which activities? | Select whether you want to delete all activity of the contact, or only the visited pages. |
Add Contact to Journey¶
Adds a contact to a journey.
| Trigger ID | Select or map the trigger you want to add a contact to. |
| Contact ID or email | Select whether you want to choose the contact by email or contact ID. |
| Contact ID/Email | Select the ID or email of the contact you want to add to the journey. |
Create Contact¶
Creates a new contact.
Email address |
Enter an email address for the contact. | This field is the identifying property of a contact. If the email address is already used, this will update an existing contact (using below fields). If it is an unused email address, a new contact will be created. Not filling in an email address will always generate a new contact but allows for duplicates to be made! |
First name
Enter the first name of the contact.
Last name
Enter the last name of the contact.
Enter the contact's Twitter account address.
Salutation
Enter the contact salutation.
Number of employees
Number of employees of the contact's company.
Company
Enter the name of the contact's company.
Title
Enter the job title.
Industry
Enter the company's industry
Phone
Enter the contact's phone number.
Mobile phone
Enter the contact's mobile phone number.
Fax
Enter the contact's fax number.
Website
Enter the contact's website.
Mailing address
Enter the mailing street, city, postal code, and country for the contact.
Owner name
Enter the owner of the lead.
Lead source
Enter the lead source.
Status
Enter the status of the contact.
Enter the contact's LinkedIn account address.
Unsubscribed
If the Yes option is selected, the email permission will be set to unsubscribed.
Session ID
Enter the session ID. If you're using Autopilot's Tracking Code, you can associate a visitor session to a contact with the Session ID contact field.
List
Enter the ID of the list you want to insert the contact to. E.g. contactlist_91053049-5582-40B4-A17F-78ADF8F25663
Note
If you copy the ID from the URL, add the contactlist_ before the ID itself (see the example above).
Use custom fields?
Select whether you want to use custom fields.
If you select the Yes option, then a custom field appears and you can fill the desired value to the field.
Note
The custom fields must be already created using the Autopilot UI in order to display the field in the Ibexa Connect module.
Searches¶
List all Contacts¶
Returns all contacts (with details).
| Limit | Set the maximum number of contacts Ibexa Connect will return during one cycle. |
List Journeys with API Triggers¶
Returns all journeys, where the API Trigger is used.
| Limit | Set the maximum number of journeys Ibexa Connect will return during one cycle. |
List all Lists¶
Retrieves all lists.
| Limit | Set the maximum number of lists Ibexa Connect will return during one cycle. |
List Contacts on List¶
Retrieves contacts that belong to a specified list.
| Limit | Set the maximum number of contacts Ibexa Connect will return during one cycle. |
| List ID | Select the list you want to retrieve contacts from. |
List Contacts on Smart Segment¶
Retrieves contacts that belong to a specified segment.
| Limit | Set the maximum number of contacts Ibexa Connect will return during one cycle. |
| Segment ID | Select the segment you want to retrieve contacts from. |
List Smart Segments¶
Retrieves all segments.
| Limit | Set the maximum number of segments Ibexa Connect will return during one cycle. |
Other¶
Make an API Call¶
Allows you to perform a custom API call.
URL |
Enter a path relative to | For the list of available endpoints, refer to the Autopilot REST API Documentation. |
Method
Select the HTTP method you want to use:
GET
to retrieve information for an entry.
POST
to create a new entry.
PUT
to update/replace an existing entry.
PATCH
to make a partial entry update.
DELETE
to delete an entry.
Headers
Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query string
Enter the request query string.
Body
Enter the body content for your API call.
Example of Use - List All Contacts¶
The following API call returns all contacts:
Matches of the search can be found in the module's Output under Bundle > Body > contacts.
In our example, 5 contacts were returned:
