How to Install and Setup Social Proofy with Webhooks?

What Is a Webhook?
A webhook (also called a web callback or HTTP push API) is a way for an app to provide other applications with real-time information. A webhook delivers data to other applications as it happens, meaning you get data immediately. Unlike typical APIs where you would need to poll for data very frequently in order to get it real-time. This makes webhooks much more efficient for both provider and consumer.

Grab Your Webhook URL
You can find your notification’s webhook URL by selecting your notification.

Custom Webhook

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.

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”: “”,
“timestamp”: 1325613278742, //optional
“ip”: “”, //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

“total”: 45,
“currency”: “USD”,
“productName”: “Shoes”, //required
“productLink”: “”, //required
“productImage”: “”

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

“products”: [{
“name”: “T-Shirt”, //required
“link”: “”, //required
“id”: 124, //can be a string
“image”: “”,
“price”: 45,
“quantity”: 3

in Integrations
Was this article helpful?
Scroll to top