Solutions keyboard_arrow_down keyboard_arrow_up
Our Solutions
Ontraport's solutions work together to give you everything you need to run your business in one centralized, easy-to-use platform.
Resources keyboard_arrow_down keyboard_arrow_up
Resources
Find free content on the latest marketing strategies, using Ontraport in your business, and finding the right software.
Visit the blog
University Pricing Chat
clear
Webhooks
Last updated on: April 20, 2023

Webhooks are a way to send information from Ontraport to a third party application, script, or website. They essentially allow your online accounts and integrated platforms to “speak” to each other.

If you’ve integrated other applications with Ontraport, you can use elements in automation maps or rules within forms to trigger information to be sent to the other application.

You can also set up API subscriptions, which send information when an event, such as a form fill-out, occurs; typically, this is set up by app developers for purposes of creating an integration.

Note that Ontraport’s Support team cannot set up or troubleshoot your API requests for you. If you need assistance setting up webhooks, you might want to hire an Ontraport Expert.

Setting up webhooks

Here are the ways that you can add webhooks in Ontraport:

In automation:

Adding webhook elements to automation map is useful because you are able to see how many contacts on a map have had a webhook send their data to your integrated platform.

  • On your automation map, add the webhook element from the Advanced tab into the spot in the journey where you’d like information to be shared.

Through global rules (Pro accounts and above):

This is the same functionality that’s available in automation maps, but using the legacy feature called Global Rules. While this will work fine, automation maps are recommended. This is a good option if you want any contact in your account who performs an action to trigger a webhook.

  1. Go to AdministrationAdvanced Features Global Rules.
  2. Go to ContactsRules (Rules can be found under all objects; if you want to make a rule for deals go to Deals > Rules).
  3. Create new rule.
  4. Select any trigger for the rule.
  5. Choose the Send to a Webhook action (note, this was formerly called “Ping URL”).

On form submissions:

If you know that you want a webhook to pass information every time that a form is submitted, and you don’t need a full automation map, another option you have is to create a rule on the form submissions.

AdministrationLegacy Features Rules for Form Submissions.

  1. Toggle on rules on form submissions (Pro level accounts and above) by going to
  2. Go to your Form Settings.
  3. Add a rule to the Always-On Rules section (for an Order Form this can be in the rules section for Successful Payment or Failed Payment).
  4. Choose the Send to a Webhook action (note, this was formerly called “Ping URL”).
  5. Enter the destination URL to designate where to send your data.
  6. Select the HTTP request method for your webhook (GET, PATCH, PUT, POST, or DELETE).
  7. Add the data you would like to send.
    • If you would like to add multiple Ontraport merge fields to your data, add an ampersand (&) at the end of a merge field before the next label (e.g. First_Name=[Page//First Name]&Email=[Page//Email]).
    • If you would like to combine the merge fields, you can add in the merge fields with a space between them (e.g. Name=[Page//First Name] [Page//Last Name]).
    • You can send your data in a variety of different content types: form-encoded, JSON, and XML. If the payload is none of those, then the data will be sent as plain text. Webhooks will automatically send the appropriate content type header along with the request; however, if a user adds a different content type header to the headers dialog, then it will override the automatic detection.
  8. Choose the number of requests you would like to send per minute and the number of retries.

View your webhook activity log

Troubleshooting webhooks can be a time-consuming pain, but Ontraport’s webhooks activity log simplifies the process. These logs allow you to view your most recent webhooks’ request and response data.

  1. Go to → AdministrationIntegrationsWebhook Logs.
  2. Add the columns that are the most helpful to you:
    • Request – Display the request your webhook sent.
    • Response Code – Show if your request was successful or if you experienced an error.
    • Date – View the date you sent your webhook. 
    • Response Data – Show your webhook’s response data. This response contains information about the status of the event.
    • Object – Display the object your webhook was for.
    • Type – See if you sent your webhook via automation maps, API, forms, etc.
    • Name – View the name of your webhook’s source. For example, you’ll see your page’s name if a visitor submits a form and triggers your webhook.
    • Webhook ID – See the specific webhook’s ID if the source isn’t an API.
  3. Click on the request you’re interested in to view its data.

API Webhook Subscriptions

Ontraport provides endpoints for applications to subscribe to a webhook via the API so that, when the subscribed event occurs (e.g. someone fills out a form associated with the subscription), Ontraport will send that information to the subscribed URL. This reduces traffic on both the developer’s server and Ontraport’s API servers by eliminating frequent requests checking for new information.

The application will need to subscribe to the API endpoint with a valid API Key and Application ID generated by the associated Ontraport account. The subscription request must include a valid URL which will receive and process the data payload in the webhook.

The available webhook subscriptions available are:

Further webhook documentation can be found in the API doc, and you can use the API Live Doc Webhooks section to check if there are existing webhook subscriptions for your account and to create subscriptions to webhook testing services such as Request.bin.


To use the API Live Doc:

  1. You need an API Key and Application ID from an active Ontraport account.
  2. Enter the API Key and Application ID in the fields in the top right corner of the screen.
  3. Scroll down and expand the section for Get /Webhooks.
  4. You can click the button to “Try it out!” near the bottom of the API Live Doc (it is not necessary to enter any parameters), and the response body will list the active webhook subscriptions for this account, if there are any.
Related university lessons
Privacy + data security
When you’re using private data about any contacts on your list via merge fields or element database connections, it’s important to keep that info under wraps. Keep your contacts’ info private and secure with the tips from this lesson.
The 5 functions of a web app
This lesson digs into the five key functions common to web apps and how to handle them using Ontraport. Watch and start drafting ideas for what your app can accomplish!
What is a web application
Learn exactly what makes a web application different from a website – so you can start dreaming of the possibilities for your business!
arrow_drop_down_circle
Divider Text
Related support articles
arrow_forward
Integration overview
arrow_forward
Use Ontraport's API
arrow_forward
Obtain Ontraport API Key and App ID
 Pro tips
Tip #1: If you want to reduce slow processing time for your webhooks, change your retry value to 0. The greater number of retries you allow, the more the processing time will increase.
Tip #2: For security purposes, send your API Key and APP ID data through headers instead of in the GET variables or POST data.
Tip #3: Ontraport pushes notification of all API changes to our API RSS Feed. Subscribe to it to have updates pushed to your favorite RSS reader.
Features
Company
Resources
Live events
Access
© Ontraport 2024
playlist_add_check
PCI DSS, Level 1
security
Privacy Shield Certified
[bot_catcher]