Ontraport

The Ontraport modules allow you to watch, create, update, search, and delete objects, rules, events, and messages in your Ontraport account.

Getting Started with Ontraport

Prerequisites

• An Ontraport account

In order to use Ontraport with Integromat, it is necessary to have an Ontraport account. If you do not have one, you can create an Ontraport account at ontraport.com/signup-pro.

Connecting Ontraport to Integromat

To connect your Ontraport account to Integromat you need to obtain the API Key from your Ontraport account and insert it in the Create a connection dialog in the Integromat module.

1. Log in to your Ontraport account.

2. Click Your Profile Icon > Administration > Integrations > Ontraport API Instructions and Key Manager.

3. Click New API Key, fill the details in the API Application and accept the agreement, enter a name for API and select the options for API. Click Save.

4. Copy the APP ID and API Key to your clipboard.

5. Go to Integromat and open the Ontraport module's Create a connection dialog.

6. In the Connection name field, enter a name for the connection.

7. In the API Key and API Application ID fields, enter the API key and APP ID copied in step 4. Click Continue.

The connection has been established.

General Object Modules

Watch Events

Receives events when objects are created, objects are tagged, objects are untagged or forms are submitted.

Webhook Name	Enter a name for the webhook.
Connection	Establish a connection to your Ontraport account.
Object Type ID	Select the Object Type ID you want to watch.
Event	Select the event you want to watch: Object Created Form Submitted Tag Added Tag Removed
Tag ID	Select the Tag ID you want to watch.
Form ID	Select Form ID you want to watch.
Data Format	Select the data format: Notify Lightweight

See the Connecting to Ontraport Webhook Using Integromat for adding the webhook in Ontraport.

Search Objects

Retrieves all objects of a certain type.

Connection	Establish a connection to your Ontraport account.
Object Type ID	Select Object Type ID whose object you want to search.
Search	Enter any keyword or phrase to filter the objects.
Search Notes	Select whether object notes can be searchable: Yes No Not defined
Object IDs	Add the Object IDs
Limit	Enter the maximum number of objects Integromat should return during one scenario execution cycle.

Get an Object

Retrieves an object.

Connection	Establish a connection to your Ontraport account.
Object Type ID	Select the Object Type ID whose object type details you want to retrieve.
Object ID	Select the Object ID whose details you want to retrieve.

Create an Object

Creates an object of a certain type. 

Connection	Establish a connection to your Ontraport account.
Object Type ID	Select the Object Type ID whose object you are creating. When you select an object, the dynamic fields related to the object type auto-populates which you have to fill for creating or updating the object. Refer to the Ontraport API Documentation.

Update an Object

Updates an object.

Connection	Establish a connection to your Ontraport account.
Object Type ID	Select the Object Type ID whose object you want to update.
Object ID	Select the Object ID you want to update. When you select an object, the dynamic fields related to the object type auto-populates which you have to fill for creating or updating the object. Refer to the Ontraport API Documentation.

Delete an Object

Deletes an object.

Connection	Establish a connection to your Ontraport account.
Object Type ID	Select the Object Type ID whose object type details you want to retrieve.
Object ID	Select the Object ID whose details you want to retrieve.

List Objects with Tag

Retrieves all objects with a certain tag. 

Connection	Establish a connection to your Ontraport account.
Object Type ID	Select the Object Type ID whose object you want to list with tag.
Tag	Enter the tags whose associated objects you want to list.
Search	Enter any keyword or phrase to filter the objects.
Search Notes	Select whether object notes can be searchable: Yes No Not defined
Limit	Enter the maximum number of objects Integromat should return during one scenario execution cycle.

Tag Objects

Tag objects.

Connection	Establish a connection to your Ontraport account.
Object Type	Select the object type to whose object you want to add the tags.
Tag	Enter the tag or keyword you want to add as a tag to the object.
Object ID	Enter the object ID to which you want to add the tag.

Untag Objects

Removes a tag from objects.

Connection	Establish a connection to your Ontraport account.
Object Type	Select the object type to whose object you want to untag.
Tag	Enter the tag or keyword you want to untag from the object.
Object ID	Select the object ID from which you want to untag.

Add an Object to a Sequence or Campaign

Adds objects to sequence or campaigns.

Connection	Establish a connection to your Ontraport account.
Object Type	Select the object type to whose object you want to add to the sequence or campaign.
Sequence or Campaign	Select whether you want to add the object to sequence or campaign: Sequence Campaign
Sequences	Select the sequence to which you want to add the object.
Campaign	Enter the campaign to which you want to add the object.
Object ID	Select the Object ID which you want to add to the sequence or campaign.

Remove an Object from a Sequence or Campaign

Removes objects from sequences or campaigns.

Connection	Establish a connection to your Ontraport account.
Object Type	Select the object type whose object you want to remove from the sequence or campaign.
Sequence or Campaign	Select the option you want to remove from the object: Sequence Campaign
Sequences	Select the sequence to which you want to remove from the object.
Campaign	Enter the campaign from which you want to remove the object.
Object ID	Select the Object ID which you want to add to the sequence or campaign.

Message

Create a Message

Creates a message.

Connection	Establish a connection to your Ontraport account.
Message Name	Enter the name of the message.
Message Subject	Enter the subject line of the message.
Message Type	Select the message type: Legacy Mail ONTRAmail (template) Text Message (SMS) Task Message
Send From Email address	Enter the email address from which you are sending the message.
From Name	Select the name that appears in the email.
Reply to Email Address	Enter the email address to which recipient can reply to.
Plain Text	Enter the email body message.
HTML Text	Enter the email body message in HTML format.
Email Title	Enter the email title.
Type	Select the email type: Marketing Email Transactional Email
Spam Score	Enter the spam score for this email so it appears in the spam folder of the recipient.
Template Content	Enter the template details. The template details may overwrite other fields that appear below this field.
SMS Content	Enter the message text.
Task Data	Enter the task details.
Due Date	Enter the date by which the task must be completed.
Task Owner	Enter the task owner's name.
Task Form	Enter the Task ID of the form which needs to be filled on completing the task.
Object Type ID	Select the Object Type ID.

Update a Message

Updates a message.

Connection	Establish a connection to your Ontraport account.
Message ID	Select the Message ID you want to update.
Message Name	Enter the name of the message.
Message Subject	Enter the subject line of the message.
Message Type	Select the message type: Legacy Mail ONTRAmail (template) Text Message (SMS) Task Message
Send From Email address	Enter the email address from which you are sending the message.
From Name	Select the name that appears in the email.
Reply to Email Address	Enter the email address to which recipient can reply to.
Plain Text	Enter the email body message.
HTML Text	Enter the email body message in HTML format.
Email Title	Enter the email title.
Type	Select the email type: Marketing Email Transactional Email
Spam Score	Enter the spam score for this email so it appears in the spam folder of the recipient.
Template Content	Enter the template details. The template details may overwrite other fields that appear below this field.
SMS Content	Enter the message text.
Task Data	Enter the task details.
Due Date	Enter the date by which the task must be completed.
Task Owner	Enter the task owner's name.
Task Form	Enter the Task ID of the form which needs to be filled on completing the task.
Object Type ID	Select the Object Type ID.

Rule

Create a Rule

Creates a rule.

Connection	Establish a connection to your Ontraport account.
Rule Name	Enter a name for the rule.
Rule Events	Enter the events for which the rule triggers. For the list of events, see here.
Rule Actions	Enter the actions for which the rule triggers. For the list of actions, see here.
Object Type ID	Select the Object Type ID for which you are creating the rules.
Rule Conditions	Enter the conditions which when met, the rule triggers. For the list of conditions, see here.
Rule Tags	Enter the keywords as tags for the rule.
Pause	Select whether the rule is paused: Live Paused

Update a Rule

Updates a rule.

Connection	Establish a connection to your Ontraport account.
Rule ID	Select the Rule ID you want to update.
Pause	Select whether the rule is paused: Live Paused
Rule Name	Enter a name for the rule.
Rule Events	Enter the events for which the rule triggers. For the list of events, see here.
Rule Actions	Enter the actions for which the rule triggers. For the list of actions, see here.
Rule Conditions	Enter the conditions which when met, the rule triggers. For the list of conditions, see here.
Rule Tags	Enter the keywords as tags for the rule.
Object Type ID	Select the Object Type ID for which you are creating the rules.

Other

Make an API Call

Performs an arbitrary authorized API call.

Connection	Establish a connection to your Ontraport account.
URL	Enter a path relative to https://api.ontraport.com/. For example: /1/Rules For the list of available endpoints, refer to the Ontraport 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 - Get Messages

The following API call returns all the messages from your Ontraport account:

URL:
/1/Messages

Method:
GET

Matches of the search can be found in the module's Output under Bundle > Body > data. 
In our example, 2 messages were returned:

Connecting to Ontraport Webhook Using Integromat

1. In the Watch events module, enter the details as mentioned in the Watch Events and copy the address to your clipboard.

2. Login to your Ontraport account and open your Campaign map > Advanced > Send to a Webhook and add the webhook information to the flow.

 

3. Add the URL address copied in step 1 and select the events for which you want to receive triggers and click Done.

You have successfully added the webhook.