qualification Webhook

Zendrive provides the ability to specify a Webhook where the Application Publisher can receive notifications of users who have qualified for offers. In this page, we have detailed the API request-response contract to support the IQL Ad program, meant for the Publisher's use.

Notes:

1. The APIs detailed in this section are subject to change, based on input from customers. Zendrive will keep this document updated to reflect the latest updates and will also ensure that all publishers are informed.

2. The Webhook URL must be a HTTPS URL. Notifications are sent as a POST request to the Webhook URL with a data block containing a JSON string.

POST URL: Publisher to provide after setting up at their end.

Headers

Name	Type	Description
Authorization*	String	APIKEY <api_key>

Zendrive will send the same API Key <API_key>that is used in all the IQL API endpoints for authorization. App Publishers need to use this API Key to verify that the webhook is coming from Zendrive.

Sample Request Payload

{
  "info": {
    "driver_id": "[email protected]",
    "publisher_app_name": "publisher",
    "webhook_created_at_timestamp": 1654506334000
  },
  "metadata": {
    "offer_created _at_timestamp": 1544506334000,
    "offer_id": "ad_123bajdh354",
    "offer_type": "Auto_Insurance",
    "offer_subtype": "Telematics",
    "advertiser_name": "test-insurer",
    "offer_headline": "Congrats ! You have qualified for a discounted offer ",
    "offer_discount_percentage": 40,
    "offer_expiry_timestamp": 1944506334000
  }
}

Response Fields

Field	Description
info.driver_id	Unique identifier for the driver
info.publisher_app_name	Name of the application
info.webhook_created_at_timestamp	Timestamp at which the qualification webhook was created
metadata.offer_created_at_timestamp	Timestamp at which the offer was created for the user
metadata.offer_id	Unique identifier for the offer for which the user is currently qualified.
metadata.offer_type	Indicates if the offer is auto_insurance or non_auto_insurance type
metadata.offer_subtype	Indicates the subtype the offer belongs to - telematics/affiliate/drive
metadata.advertiser_name	Advertiser’s name
metadata.offer_headline	Offer headline
metadata.offer_discount_percentage	Indicates specific discount percentage available as per the offer
metadata.offer_expiry_timestamp	Timestamp at which the offer will expire for the user

Recommended design

A mechanism similar to a queue should be in place to ingest the webhooks, to prevent any webhook data loss.