You can integrate your Retention.com account directly with webhooks.
This integration will send any Reclaim events you have enabled on your site to a webhook of your choosing.
You must have our Reclaim Scripts (Add to Cart, Viewed Product, Viewed Category, Checkout Started, Active on Site) implemented on your site for this to work.
To get started
1. Click on Integrations from the left navigation panel in Retention.com. Then, click Available Integrations at the top, type Webhook, and choose Webhook Reclaim.
2. Type your webhook URL into Webhook URL field.
You can also enter custom JSON data in the box below it. This will be merged with the event data we pass through to the webhook endpoint.
If you get an error with credentials here, that error is coming from your URL's server.
Authentication
Our integration supports authentication through headers or body parameters. If you have authentication set up for your webhook, please include the necessary key and value in either the Custom Headers (Header) or Custom JSON Data (Body).
3. Click YES to enable your Reclaim event sync. Click Next.
4. If your Webhook URL and Custom JSON data are accurate, you will see a success confirmation in the top right if the URL is correct.
5. Once the integration is successfully created, we will automatically send an Add to Cart Reclaim test event.
You will be able to identify them through the field 'event_type' that we send in the event payload.
Below you can find examples for how our events will appear:
Add to Cart Reclaim
{
"email": "test@retention.com",
"event_type": "Add To Cart Reclaim",
"occurred_at": "2023-09-05T20:48:20Z",
"properties": {
"product_url": "https://www.retention.com",
"product_name": "Test Product",
"product_id": "123456",
"product_image_url": "https://images.retention.com/assets/logo-full-page.png",
"product_price": "10.00",
"quantity": "1"
},
"testing_custom_params": "test",
Viewed Product Reclaim
{
"event_type": "Viewed Product Reclaim",
"properties": {
"url": "https://www.test.com/products/test-test",
"name": "test test",
"brand": "test test",
"price": "$1",
"image_url": "https://cdn.shopify.com/test.jpg",
"product_id": 123456789,
"compare_at_price": "$10"
},
"occurred_at": "2023-02-27T10:42:25Z",
"email": "test@retention.com",
Active on Site Reclaim
{
"event_type":"Active on Site Reclaim",
"properties":{
"page":"http://kuhn.com/josefina.powlowski",
"domain":"bednar.net",
"mobile":true,
"visits":6,
"browser":"Chrome",
"platform":"Mac",
"referrer":"http://rowe-wilderman.com/augustine",
"page_title":"Granola",
"user_agent":"Opera/9.80 (X11; Linux i686; Ubuntu/14.10) Presto/2.12.388 Version/12.16",
"browser_version":"0.4.0"
},
"occurred_at":"2024-10-24T16:08:29Z",
"email":"alessa.l.jenkins+13661@gmail.com"
}
Viewed Category Reclaim
{
"event_type":"Viewed Category Reclaim",
"properties":{
"url":"https://retention.com/category/new-arrivals?page=1",
"name":"Retention Category"
},
"occurred_at":"2024-10-24T16:10:11Z",
"email":"alessa.l.jenkins+13661@gmail.com"
}
Checkout Started Reclaim
{
"event_type":"Checkout Started Reclaim",
"properties":{
"cart_id":"bfih1hxq4fkya287fk",
"currency":"USD",
"line_items":[
{
"id":"jjb3sm17ds",
"title":"Frosting",
"variant":{
"id":"84r9rpw280",
"sku":"g1gjv3s",
"image":{
"src":"https://loremflickr.com/300/300"
},
"price":{
"amount":43.71,
"currency_code":"USD"
},
"title":"Cookie",
"product":{
"id":"02f6k908ii",
"type":"Gummy Bears",
"title":"Cheesecake"
}
},
"quantity":4
}
],
"cart_amount":33.88
},
"occurred_at":"2024-10-24T16:11:11Z",
"email":"alessa.l.jenkins+13661@gmail.com"
}
5. Click Enable, and your collection sync settings will apply and begin. Then, click Finish.
6. You will be taken to the Integration Settings. From here you can view your API Details (Webhook URL and Custom JSON data), Disable/Enable, Remove the integration, or turn Reclaim sync on/off.
See Reclaim events
You can see these events successfully passing through in your Retention.com account once they're collected.
Go to Event Details > Added to cart. This is an easy way to confirm that our events have been successfully implemented.
You can also see the Viewed Product Reclaim option populate under Event Details.
The same applies to all other Reclaim events.
Have questions? Message us on chat, or email us at support@retention.com!