1. Home
  2. Using Widgets
  3. Using Webhook Triggers

Using Webhook Triggers

Integrate Social Proofy with another platform/app through Webhooks to collect form entries/conversions, and create Notification Data by following this guide.

Webhook Trigger Integration

Step 1 – Click on the pencil icon for the Widget you wish to connect with Webhooks.

Edit Notification

Step 2 – Go to the Webhook & Auto Capture tab, copy the Webhook Trigger URL and paste it in the Webhook Area for the plaftform/app you wish to connect with.

Copy Webhook Trigger

Step 2 – If you used the Webhook Trigger, then make sure you toggle the Webhook and Upload button under Select Widget Version.

Webhook and Upload - Widget Version

If you are using the Social Proofy WordPress Plugin for WooCommerce and WordPress then toggle the Plugins button under Select Widget Version. 

Plugin - Widget Version

Check If Webhooks Are Collecting Data

To check if your Webhooks are collecting data go to the Notification Data tab for the widget you wish to confirm.

Step 1 – Click on the Notification Data tab in your widget settings.

Notification Data

Step 2 – If your Webhook connection is working you will see Conversion Data being shown.

You will also notice that under Type it will have the name of the app you integrated with (ex:WooCommerce) or it will say Webhook.

Webhook Notification Data

This Is How Webhooks Work

What Is a Webhook?
A webhook, also known as a web callback or HTTP push API, enables an application to instantly furnish other applications with real-time data. It delivers data to other applications promptly as events occur, ensuring immediate access to information. In contrast to conventional APIs that necessitate frequent polling for real-time data retrieval, webhooks offer a more efficient solution for both providers and consumers.

HTTP Method
Use the POST method for all of your webhook requests.

Optional Fields
Conversion Notification webhooks don’t need any of the parameters below, a simple HTTP POST request is enough.

Naming of Parameters

It is possible that your webhook will send the parameters in another format. As in, instead of firstName it could be first_name. If so, insert the parameter as it was sent. In this case: {first_name}.

Basic Parameters
The parameters are used in Conversion widgets webhooks only:

(required) email – required, the email associated with the conversion/lead (string)
timestamp – a numeric timestamp in milliseconds or seconds (integer)
ip – the user’s IP, to display the converting user’s location, Geo IP (string)
firstName – the lead’s first name (displayed in the notification), if not provided we’ll look up the name using the email
lastName – the lead’s last name (only the first letter is shown in the icon/avatar), if not provided we’ll look up the name using the email
city – the city
country – the country (if omitted will lookup using countryCode)
country_code – the country code (if omitted, will lookup using country)

{
“email”: “[email protected]”,
“timestamp”: 1325613278742, //optional
“ip”: “132.12.45.103”, //optional
“firstName”: “John”, //optional
“lastName”: “Doe” //optional
“guid”: “id” //optional, product/category identifier
“city”: “London”, // optional
“country”: “United Kingdom”,
“country_code”: “UK”, // optional
}

Purchase Parameters
The product can be displayed after the notification’s message text and have the notification automatically link to the product

productName – the name of the product (will be appended to the message text)
productLink – the link/URL the product page (will redirect to this link on click)
productImage – the link/URL to the product image (will display in the notification image)
total – purchase total amount
currency – the order amount currency

{
//ALL ARE OPTIONAL
“total”: 45,
“currency”: “USD”,
“productName”: “Shoes”, //required
“productLink”: “https://juststore.com/shoes”, //required
“productImage”: “https://juststore.com/shoes.jpg”
}

Multiple Products Parameters
Purchases that have multiple products/line items (optional).

products – array of products associated with event (object properties):
(required) name – product’s name to display in notification (will be appended to the message text).
(required) link – link to the product page
id – the product’s id
image – product’s image (optimal: 72×72 image)
price – product’s price
quantity – number of items purchased

{
//OPTIONAL
“products”: [{
“name”: “T-Shirt”, //required
“link”: “https://juststore.com/t-shirt”, //required
“id”: 124, //can be a string
“image”: “https://juststore.com/images/t-shirt.png”,
“price”: 45,
“quantity”: 3
}]
}

Updated on 21/10/2024

Was this article helpful?

Related Articles