Webhooks are automated data packages sent from an app whenever specific events happen. You can think of webhooks like a notification similar to the ones you receive on mobile devices. 

In Refersion, you can set up webhooks to receive notifications with information about affiliate activity and conversions in your account. Webhooks are triggered based on actions in your Refersion account. To start using the webhooks feature, please contact a member of our customer success team at helpme@refersion.com to enable the feature for your account.


Setting up a webhook in Refersion

To get started, navigate to Account > Settings > Webhooks (on the bottom left) and click + Create New Webhook.

A new window will pop up like the one below.

In the popup, you can choose a topic for receiving webhook notifications. Once a topic is selected, enter the URL where Refersion should send the webhook data. To see webhooks in action, you can set up a test URL to receive the webhooks. RequestCatcher is a great way to test for free.


Webhook Topics

Your webhook URL can receive the following topics/events from Refersion:

  • New Conversion
  • Conversion Approved
  • Conversion Denied
  • New Affiliate
  • Affiliate Status Change
  • Affiliate Details Change
  • New Conversion Trigger

You can configure multiple webhooks and specify which topics/events you wish to send to each URL. You can also select All Topics, in which case all the events listed above will send out to the designated URL(s).

Webhook Data Overview and Examples:

The data you receive from the webhook will be in JSON format. Please see examples of our webhooks below:


Conversions

The New Conversion, Conversion Approved, and Conversion Denied webhook topics, contain data about the order, the affiliate who referred the sale, the affiliate's offer details, and the click data associated with the order. The information in this webhook topic may be useful for merchants looking to route conversion data into a third-party system.

Sample webhook data below:

{

   "id": 987654321,
   "created": "2020-02-14 18:48:42",
   "status": "PENDING",
   "denied_reason_code": null,
   "is_recurring": false,
   "total_items": "1",
   "total": "130.55",
   "commission_total": "10.00",
   "currency": "USD",
   "is_test_conversion": "FALSE",
   "payment_status": "UNPAID",
   "updated": null,
   "affiliate": {
      "id": "123456",
      "code": "123ab",
      "first_name": "John",
      "last_name": "Smith",
      "email": "JohnSmith@email.com"
   },
   "payment_id": null,
   "offer": {
      "id": 12345,
      "name": "Standard Affiliate Commission",
      "type": "PERCENT_OF_SALE",
      "amount": "10"
   },
   "customer": {
      "name": "Jane Doe",
      "email": "JaneDoe@email.com",
      "browser_ip": "11.222.333.44"
   },
   "coupon_code": null,
   "order_id": "1022",
   "subscription_id": null,
   "reason": null,
   "notes": null,
   "product names": null,
   "click": {
      "created": "2019-11-06 18:44:41",
      "referer": null,
      "landed_url": "https://samplestore.com/?rfsn=3321631.89b4ba",
      "ip": "00.111.222.33",
      "sub_id": null,
      "creative_id": null
   },
   "source": "SHOPIFY"
}

Affiliates

The New Affiliate, Affiliate Status Change, and Affiliate Details Change webhook topics contain data about the affiliate's name, address, registration details, custom fields, and offer. The information in this webhook topic may be useful for merchants looking to route affiliate data into a CRM, email marketing/newsletter system, or e-commerce system. 

Sample webhook data below:

{
  "id": 123456,
  "code": "123ab",
  "status": "PENDING",
  "last_login": "0000-00-00 00:00:00",
  "last_conversion": "0000-00-00 00:00:00",
  "first_name": "John",
  "last_name": "Smith",
  "email": "JohnSmith@email.com",
  "paypal_email": null,
  "company": "",
  "address_1": "123 Street Road",
  "address_2": "Suite 7",
  "city": "New York",
  "state": "NY",
  "zip": "11111",
  "country": "",
  "phone_number": "",
  "source": "MERCHANT_PROFILE",
  "custom_fields": [
    {
      "id": "55555",
      "name": "INSTAGRAM HANDLE",
      "value": "Bee_Handle"
    }
  ],
  "offer": {
    "id": "44444",
    "name": "Tiered Offer"
  },
  "is_marketplace_user": false
}


Conversion Triggers

The New Conversion trigger webhook topic contains information related to newly added conversion triggers in your account. The information in this webhook topic may be useful for merchants looking to auto-create coupons/discount codes in their e-commerce platforms after they are created in Refersion.

Sample webhook data below:

{
  "id": 7654321,
  "affiliate_id": "123456",
  "trigger": "CUSTOMER@TRIGGER.COM",
  "type": "EMAIL"
}
Did this answer your question?