Ontraport API Essential Guide

What type of API does Ontraport provide?

The most common API types today are REST, SOAP, GraphQL, and RPC. REST is currently the most widely used API architecture for web services. SOAP is an older protocol that is still used in some enterprise and financial applications. GraphQL is a newer query language for APIs that has gained popularity in recent years.

To determine the API type for a specific service like Ontraport, always refer to the official documentation provided by the company. If the information is not readily available, you may need to contact Ontraport's support or developer relations team for accurate details about their API.

Does the Ontraport API have webhooks?

Yes, the official Ontraport API does have webhooks. Here are the key points about Ontraport's webhook functionality:

Webhook Availability

Ontraport provides webhooks as part of their API functionality.

Types of Events You Can Subscribe To

Ontraport allows you to subscribe to the following types of events via webhooks:

1. Object is created (Contact or Custom Object record)
2. Form is submitted
3. Tag is added
4. Tag is removed
5. Product is purchased
6. Transaction is added

How to Use Webhooks

There are multiple ways to set up and use webhooks in Ontraport:

1. API Webhook Subscriptions: Applications can subscribe to webhooks via the API. When the subscribed event occurs, Ontraport will send that information to the subscribed URL.

2. In Automation Maps: You can add webhook elements to automation maps to share information at specific points in a customer journey.

3. Through Global Rules (Pro accounts and above): This allows you to trigger webhooks based on actions performed by any contact in your account.

4. On Form Submissions: You can set up webhooks to trigger when forms are submitted.

Webhook Activity Log

Ontraport provides a webhook activity log that allows you to view and troubleshoot your recent webhooks' request and response data.

Best Practices

• Use the API Live Doc to check existing webhook subscriptions and create new ones.
• Utilize the webhook activity log for troubleshooting.
• When building integrations, consider using a Sandbox account to test without affecting your live data.

Remember to obtain an API Key and Application ID from your Ontraport account before working with the API and webhooks.

Rate Limits and other limitations

Here are the key points about the API Rate Limits for the Ontraport API:

Rate Limits

• Ontraport allows up to 180 API requests per minute per account [2].

• This is a rolling limit that resets each minute [2].

• There is no monthly limit on total API requests [1].

Key Considerations

• If you need more than 180 requests per minute, Ontraport recommends:

  1. Checking that you are utilizing pagination correctly
  2. Implementing caching functionality
  3. Contacting Ontraport support to request a higher limit on a per-account basis [2]

• Ontraport provides a way to see how many API requests you have left per minute so you don't exceed the rate limit [1].

• For processing large quantities of data, proper use of pagination is recommended [2].

Best Practices

• Utilize pagination and caching to optimize your API usage and stay within rate limits.

• Monitor your API usage to avoid hitting the rate limit.

• Contact Ontraport support if you have a legitimate need for a higher rate limit.

• Use the webhook activity log to identify and fix any issues with outbound webhooks [1].

In summary, while Ontraport does not impose a monthly limit on total API requests, they do have a per-minute rate limit of 180 requests. This limit is designed to allow for extensive automation while preventing abuse. Proper implementation of pagination and caching can help stay within these limits for most use cases.

Latest API Version

Based on the search results provided, I could not find a specific mention of the most recent version of the Ontraport API. However, I can provide some relevant information about Ontraport's API:

Key Points:

1. Ontraport offers an API that allows for integrating third-party software with Ontraport accounts, enabling users to do more with their accounts and share data across platforms.

2. In 2019, Ontraport unveiled a new API with significant enhancements, including:

   • Upgrade from XML response data format to JSON format
   • More RESTful HTTP request support and proper HTTP response codes
   • Use of the Swagger API Framework for an intuitive UI and live testing of credentials

3. Ontraport provides API documentation that gives users all the information needed to use their API, including relevant use cases. Users can also use the API Live Doc to test their API code.

4. To use the API, users need to obtain a unique API key and App ID.

Using the API:

• Users can perform the same actions available in Ontraport through the API, such as adding contacts, changing contacts, and adding fields.
• Webhooks can be used to automate actions through the API that may be more complex to perform manually or through automation maps.
• Ontraport provides various endpoints for users to interact with their API.

Best Practices:

• While Ontraport continues to service requests to existing APIs, they strongly encourage adoption of the new API (as of 2019) for any new integrations with Ontraport.
• For developers looking to create integrations, Ontraport offers sandbox accounts to test integrations in a risk-free environment.

While I couldn't find the specific version number of the most recent API, it's clear that Ontraport has made significant updates to their API in recent years. For the most up-to-date information on the current version, it would be best to check Ontraport's official API documentation or contact their support directly.

How to get a Ontraport developer account and API Keys?

Here's how to get a developer account for Ontraport to create an API integration:

Key Steps

1. Log in to your Ontraport account.

2. Navigate to Administration > Integrations > Ontraport API Instructions and Key Manager.

3. Click on "New API Key".

4. If prompted, fill out the API Application form and submit it. Approval typically takes 1-2 business days.

5. Once approved, return to the API Key Manager, name your API key and App ID, set the contact owner, and click Save.

6. You'll then be able to view your API Key and App ID.

Key Points to Consider

• You need both an API Key and App ID to make API requests.
• Sandbox accounts are available for testing integrations without affecting live data.
• The API allows you to perform most actions available in Ontraport, like adding/modifying contacts, adding fields, etc.
• Webhooks can be used to send information from Ontraport to third-party applications.

Best Practices

• Review the comprehensive API documentation before starting development.
• Use the API Live Doc to test your API code.
• Check Ontraport's list of existing integrations before building a new one.
• Ensure you provide necessary permissions to the API key owner.
• Test the connection thoroughly before using it in production.

By following these steps, you'll be able to obtain the necessary credentials to start developing your Ontraport API integration. Remember to review the full API documentation for detailed information on available endpoints and how to structure your requests.

What can you do with the Ontraport API?

Based on the search results provided, here is a list of data models you can interact with using the Ontraport API, along with what is possible for each:

Contacts

• Add new contacts
• Update existing contact information
• Retrieve contact data
• Delete contacts
• Add or remove tags from contacts
• Add contacts to automation campaigns

Forms

• Create new forms
• Update existing forms
• Retrieve form submission data
• Set up webhooks to trigger actions when forms are submitted

Transactions

• Process new transactions
• Retrieve transaction data
• Create new deals based on transactions

Products

• Add new products
• Update product information
• Retrieve product data

Custom Objects

• Create and manage custom objects
• Add, update, and retrieve data for custom objects

Tags

• Create new tags
• Add or remove tags from contacts
• Retrieve tag data

Automation Campaigns

• Add contacts to automation campaigns
• Create or update automation maps
• Retrieve campaign data

Fields

• Add custom fields
• Update field information
• Retrieve field data

Messages (Email & SMS)

• Send email and SMS messages
• Retrieve message data and statistics

Orders

• Create and manage orders
• Process upsells and order bumps

Membership Sites

• Manage membership levels and access
• Retrieve membership data

Key points to consider:

• The API uses JSON-formatted responses
• Authentication is done using an API key and App ID
• The API follows RESTful principles with proper HTTP response codes
• You can test API calls directly in the documentation interface

Best practices:

• Use the new API for any new integrations with Ontraport
• Refer to the official API documentation for the most up-to-date information on endpoints and parameters
• Utilize the Swagger API Framework for testing and exploring the API capabilities