Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Drawio
mVer2
zoom1
simple0
inComment0
pageId1647444023
custContentId3362848776
lbox1
diagramDisplayNamewebhooks.drawio
contentVer1
revision1
baseUrlhttps://ingenioustechnologies.atlassian.net/wiki
diagramNamewebhooks.drawio
pCenter0
width570
links
tbstyle
height101

...

  • An URL-based

  • javascript (only for browser-side, deprecated)

  • An iframe (only for browser-side, inline frame, deprecated)

Because they can effect the performance of the advertiser’s confirmation page, javascripts and iframes need to be approved by the platform administrator before they are activated.

...

  • Go to the overview page and look at the Replacements panel at the bottom of the page.

  • Click on the button ‘create new replacements’ in the lower right corner of the panel.

  • In the window appearing now, give your replacements a name and a brief description.

  • Proceed to click the button ‘add new replacement’. Fill out the value you want to replace under ‘original value’ and the value you want it to replaced by under ‘replace with’.

  • To add more values, just click on the button ‘add new replacement’ again. To remove values, click on the icon next to them.

  • When you are ready, click on the button ‘save’. If you do so, you will find the replacements added to the overview.

  • Finally, make sure you activate the replacements by adding it to one or more rules. To do so, edit the rule and select it under ‘Replacements’.

Testing Webhooks

Using Postman-Echo

  1. Use https://postman-echo.com/get as your target URL. For example:

https://postman-echo.com/get?ADVERTISER_MID=#{ADVERTISER_MID}&WINNER_AMC_ADSPACE_ID=#{WINNER_AMC_ADSPACE_ID}&WINNER_AMC_ADMEDIA_ID=#{WINNER_AMC_ADMEDIA_ID}&CONVERSION_ID=#{CONVERSION_ID}&TIME_STAMP_MS=#{TIME_STAMP_MS}&CONVERSION_TARGET=#{CONVERSION_TARGET}&TRACKING_CATEGORY=#{TRACKING_CATEGORY}&APPLIED_TRACKING_CATEGORY=#{APPLIED_TRACKING_CATEGORY}&CONVERSION_STATUS=#{CONVERSION_STATUS}&ORDER_VALUE=#{ORDER_VALUE}&CURRENCY=#{CURRENCY}&BOOKING_CURRENCY=#{BOOKING_CURRENCY}&BOOKING_AMOUNT=#{BOOKING_AMOUNT}&DISCOUNTED_ORDER_VALUE=#{DISCOUNTED_ORDER_VALUE}&INVOICE_VALUE=#{INVOICE_VALUE}&COMM_AMOUNT=#{COMM_AMOUNT}&DISCOUNT_CODE=#{DISCOUNT_CODE}&DISCOUNT_VALUE=#{DISCOUNT_VALUE}&WINNER_FREE_PARAM_smc1=#{WINNER_FREE_PARAM_smc1}&WINNER_FREE_PARAM_smc2=#{WINNER_FREE_PARAM_smc2}&WINNER_FREE_PARAM_smc3=#{WINNER_FREE_PARAM_smc3}&WINNER_FREE_PARAM_smc4=#{WINNER_FREE_PARAM_smc4}&WINNER_FREE_PARAM_smc5=#{WINNER_FREE_PARAM_smc5}&WINNER_FREE_PARAM_smc6=#{WINNER_FREE_PARAM_smc6}&IS_CUSTOMER_NEW=#{IS_CUSTOMER_NEW}&DEVICE_TYPE_NAME=#{DEVICE_TYPE_NAME}&USER_VALUE_1=#{USER_VALUE_1}&USER_VALUE_2=#{USER_VALUE_2}&WINNER_GCLID=#{WINNER_GCLID}

2. Use the the webhook logs to see your webhooks in action:

Using the logs to troubleshoot server-side Webhooks

Using PostBin

Your PostBin will be available for 30 minutes. After that you have to create a new PostBin.

To test webhooks, we recommend to use PostBin (https://www.toptal.com/developers/postbin/).

  1. Create a new bin

...

2. Your “bin” will get a unique Url, which you should write down. It has this form:

https://www.toptal.com/developers/postbin/${UNIQUE_ID}

...

3. You now can use the URL of your “bin” in your Webhook target URL for testing, for example:

https://www.toptal.com/developers/postbin/${UNIQUE_ID}?ADVERTISER_MID=#{ADVERTISER_MID}&WINNER_AMC_ADSPACE_ID=#{WINNER_AMC_ADSPACE_ID}&WINNER_AMC_ADMEDIA_ID=#{WINNER_AMC_ADMEDIA_ID}&CONVERSION_ID=#{CONVERSION_ID}&TIME_STAMP_MS=#{TIME_STAMP_MS}&CONVERSION_TARGET=#{CONVERSION_TARGET}&TRACKING_CATEGORY=#{TRACKING_CATEGORY}&APPLIED_TRACKING_CATEGORY=#{APPLIED_TRACKING_CATEGORY}&CONVERSION_STATUS=#{CONVERSION_STATUS}&ORDER_VALUE=#{ORDER_VALUE}&CURRENCY=#{CURRENCY}&BOOKING_CURRENCY=#{BOOKING_CURRENCY}&BOOKING_AMOUNT=#{BOOKING_AMOUNT}&DISCOUNTED_ORDER_VALUE=#{DISCOUNTED_ORDER_VALUE}&INVOICE_VALUE=#{INVOICE_VALUE}&COMM_AMOUNT=#{COMM_AMOUNT}&DISCOUNT_CODE=#{DISCOUNT_CODE}&DISCOUNT_VALUE=#{DISCOUNT_VALUE}&WINNER_FREE_PARAM_smc1=#{WINNER_FREE_PARAM_smc1}&WINNER_FREE_PARAM_smc2=#{WINNER_FREE_PARAM_smc2}&WINNER_FREE_PARAM_smc3=#{WINNER_FREE_PARAM_smc3}&WINNER_FREE_PARAM_smc4=#{WINNER_FREE_PARAM_smc4}&WINNER_FREE_PARAM_smc5=#{WINNER_FREE_PARAM_smc5}&WINNER_FREE_PARAM_smc6=#{WINNER_FREE_PARAM_smc6}&IS_CUSTOMER_NEW=#{IS_CUSTOMER_NEW}&DEVICE_TYPE_NAME=#{DEVICE_TYPE_NAME}&USER_VALUE_1=#{USER_VALUE_1}&USER_VALUE_2=#{USER_VALUE_2}&WINNER_GCLID=#{WINNER_GCLID}

4. When the Ingenious-system fires a Webhook, you then can refresh you “bin” url in the browser to see incoming webhooks:

...

5. Use also the webhook logs to see your webhooks in action:

Using the logs to troubleshoot server-side Webhooks

Using RequestCatcher

  1. Open this website, and keep the website open:

https://wehook-test.requestcatcher.com

2. Configure the Target-URL of your webhook, for example:

...

Using the logs to troubleshoot server-side Webhooks

Webhook logs allow you to troubleshoot server-side Webhook executions. You will find comprehensive information in this article: Using the logs to troubleshoot server-side Webhooks

Testing Webhooks

Webhooks call your system and pass parameters. If you don’t have a testing area within your system, or your system is limited in terms of looking in to logs, you can you publicly available webhook-systems for testing purposes. This way your webhooks are executed, and you can debug the results.

There are several webhook-testing systems available:

Using Postman-Echo

  1. Use https://postman-echo.com/get as your target URL. For example:

https://postman-echo.com/get?ADVERTISER_MID=#{ADVERTISER_MID}&WINNER_AMC_ADSPACE_ID=#{WINNER_AMC_ADSPACE_ID}&...

2. Use the the webhook logs to see your webhooks in action:

Using the logs to troubleshoot server-side Webhooks

Using PostBin

Your PostBin will be available for 30 minutes. After that you have to create a new PostBin.

To test webhooks, we recommend to use PostBin (https://www.toptal.com/developers/postbin/).

  1. Create a new bin

...

2. Your “bin” will get a unique Url, which you should write down. It has this form:

https://www.toptal.com/developers/postbin/${UNIQUE_ID}

...

3. You now can use the URL of your “bin” in your Webhook target URL for testing, for example:

https://www.toptal.com/developers/postbin/${UNIQUE_ID}?ADVERTISER_MID=#{ADVERTISER_MID}&WINNER_AMC_ADSPACE_ID=#{WINNER_AMC_ADSPACE_ID}&...

4. When the Ingenious-system fires a Webhook, you then can refresh you “bin” url in the browser to see incoming webhooks:

...

5. Use also the webhook logs to see your webhooks in action:

Using the logs to troubleshoot server-side Webhooks

Using RequestCatcher

  1. Open this website, and keep the website open:

https://wehook-test.requestcatcher.com

2. Configure the Target-URL of your webhook, for example:

https://wehook-test.requestcatcher.com/test?ADVERTISER_MID=#{ADVERTISER_MID}&WINNER_AMC_ADSPACE_ID=#{WINNER_AMC_ADSPACE_ID}&WINNER_AMC_ADMEDIA_ID=#{WINNER_AMC_ADMEDIA_ID}&...

3. Once a webhook is called, the website will show the call

...