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 Ibexa Connect, 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.
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting Ontraport to Ibexa Connect¶
To connect your Ontraport account to Ibexa Connect you need to obtain the API Key from your Ontraport account and insert it in the Create a connection dialog in the Ibexa Connect 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 Ibexa Connect 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. |
Object Type ID |
Select the Object Type ID you want to watch. |
Event |
Select the event you want to watch:
|
Tag ID |
Select the Tag ID you want to watch. |
Form ID |
Select the Form ID you want to watch. |
Data Format |
Select the data format:
|
See the Connecting to Ontraport webhook using Ibexa Connect for adding the webhook in Ontraport.
Search Objects¶
Retrieves all objects of a certain type.
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:
|
Object IDs |
Add the Object IDs |
Limit |
Enter the maximum number of objects Ibexa Connect should return during one scenario execution cycle. |
Get an Object¶
Retrieves an object.
| 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.
| 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.
| 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.
| 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.
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:
|
Limit |
Enter the maximum number of objects Ibexa Connect should return during one scenario execution cycle. |
Tag Objects¶
Tag objects.
| 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.
| 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.
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:
|
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.
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:
|
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.
Message Name |
Enter the name of the message. |
Message Subject |
Enter the subject line of the message. |
Message Type |
Select the message type:
|
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 the recipient can reply. |
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:
|
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.
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:
|
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 the recipient can reply. |
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:
|
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.
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:
|
Update a Rule¶
Updates a rule.
Rule ID |
Select the Rule ID you want to update. |
Pause |
Select whether the rule is 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.
URL |
Enter a path relative to | 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 Ibexa Connect¶
1. In the Watch events module, enter the details as mentioned in the Watch Events and copy the address to your clipboard.
2. Log in to your Ontraport account and open your Campaign map > Advanced > Send to a Webhook and add the webhook information to the flow.
You can also add webhooks from your Administration settings, see Ontraport Webhooks for more information.
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.