Webhooks

Websites that wish to store certain information in their own database have the ability to create server to server webhooks for various events.

Currently, you can create a Webhook for new subscribers, notification clicks, or notification impressions. To get this setup, hit ‘Websites’ in the sidebar and select ‘Edit’ next to the website you want to get this set up for. You’ll then find the ‘Webhooks’ tab at the top of the page. Simply hit ‘Add Webhook’, select which type, input the URL you want, and press save.


 

Webhooks are sent as a POST with the following URL parameters added:


Webhook Type URL Parameter(s) Passed Example
New Subscriber
  • id_site (Website ID)
  • subscriber_uid (Subscriber ID)
  • webhook_source (static text - aimtell.com)
https://yoursite.com?id_site=33&subscriber_uid=0fc77bb3-4c07-42bd-dfe9-04031f1b4d2b&webhook_source=aimtell.com
Push Notification Click
  • id_site (Website ID)
  • campaign_id (Campaign ID)
  • subscriber_uid (Subscriber ID)
  • push_source (static text - aimtell.com)
https://yoursite.com?id_site=33&campaign_id=100313&subscriber_uid=0fc77bb3-4c07-42bd-dfe9-04031f1b4d2b&push_source=aimtell.com
Push Notification Impression
  • id_site (Website ID)
  • campaign_id (Campaign ID)
  • subscriber_uid (Subscriber ID)
  • push_source (static text - aimtell.com)
https://yoursite.com?id_site=33&campaign_id=100313&subscriber_uid=0fc77bb3-4c07-42bd-dfe9-04031f1b4d2b&push_source=aimtell.com

 

 You can set up multiple webhooks for any website you have set up web push for.

Webhook Variables (Advanced)

If you'd like to pass some additional information in the Webhooks for Push Notification Clicks and Push Notification Impressions, you can take advantage of the additional Webhook Variables that are available for use. Simply add the URL Parameters listed below into the Webhook URL to pass the data associated with it.

 

Webhook Variable Variable URL Parameter
Title of the Push {title}
Body of the Push

{body}

Destination Link

{link}

Type of Push Campaign, (RSS, Manual, etc) {push_type}
Browser {browser}

 

Please note that the above variables will not only work within the Notification Click and Notification Impression Webhook.