Skip to main content
Integrate with Webhooks for Reclaim
Updated this week

You can integrate your Retention.com account directly with webhooks.

  1. This integration will pass an Add to Cart and/or Viewed Product event to your webhook.

  2. You must have our Add to Cart script and/or Viewed Product script implemented.

To view/test receiving the data we send, we recommend you test your webhook using a site like webhook.site.

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 two test events: Add to Cart Reclaim and Viewed Product Reclaim.

You will be able to identify them through the field 'event_type' that we send in the event payload. Here's how those 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",

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 Add to Cart and Viewed Product 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.

Have questions? Message us on chat, or email us at support@retention.com!

Did this answer your question?