Webhooks for affiliates

How to use webhooks

Webhooks can be configured to send data and notifications from your Attribution affiliates portal to other tools.

🚧

Webhook usage

POST requests can be made for the following events:

  1. A conversion event has been completed
  2. A conversion has been approved and paid out

Create your webhook

You can create your webhook by navigating to the 'Profile' page within your affiliates portal.

📘

Test your webhook

Use a tool like https://webhook.site to see your payload

  1. Add your webhook URL in the 'Webhook section'
  2. Press 'save' to send a test event

TIP: Use a tool like https://webhook.site to see your payload

Please see the example request below:

{
"conversion_id": "c12345",
"landing_page_url": "https://example.com/landing-page",
"landing_page_visited_at": "2021-06-04T11:15:14.452Z",
"offer_name": "Test offer",
"offer_id": "o12345",
"project_name": "Test project",
"project_id": "p12345",
"atb_revenue": 12.34,
"payout": 1.23,
"status": "captured",
"affiliate_id": "a12345",
"click_id": "c12345",
"params": {
"custom_param": "param-value"
}
}

Please see payload definitions below:

conversion_id: Unique ID of conversion

landing_page_url: Landing page

landing_page_visited_at: Timestamp of user's visit 

offer_name: Advertiser's offer name

offer_id: Advertiser's offer unique ID

project_name: Advertiser's name

project_id: Advertisers unique ID

atb_revenue: Revenue of conversion event

status: Status of conversion:
  captured:  Conversion event detected
  approved:  Conversion accepted for payout to affiliate
  rejected:  Not accepted for payout to affiliate
  payout_prepared:  Conversion added to pending payout
  completed:  Payout is issued

affiliate_id: Your unique ID

payout - this amount will be paid out to affiliate (if any)

params - additional params you added to your affiliate URL. These can be `subid` or any param you like to track in webhook and reports

GET request

If your endpoint expects not POST but GET webhooks, please select this option on the webhook settings form.

After that you will be receiving GET requests with all the params now included in request URL itself, e.g:

https://YOUR-ENDPOINT.COM?affiliate_id=a12345&atb_revenue=12.34&click_id=c12345&conversion_id=c12345&landing_page_url=https%3A%2F%2Fexample.com%2Flanding-page&landing_page_visited_at=2021-06-07T09%3A04%3A16.995Z&offer_id=o12345&offer_name=Test%20offer¶ms_custom_param=param-value&payout=1.23&project_id=p12345&project_name=Test%20project&status=captured

If you have any questions please contact [email protected]