Configuring Engagement Webhooks

To ensure the success of the IQL program, publishers need to periodically engage with their user base through reminders and updates. To achieve this purpose, Zendrive enables publishers to configure engagement webhooks, and sends them webhook notifications. The publishers, in turn, can use these webhook notifications to engage users via push-notifications, email, or SMS, in-app notifications, and so on.

About Types of Available Webhooks

Zendrive provides 2 types of webhooks - Milestone Based and Activity Based. Each of these webhook types have several subtypes, as follows:

1. Milestone Based Webhooks

   1. Trips taken

   2. Program Opt-in days

   3. Preemptive Alert

2. Activity Based Webhooks

   1. Permission issues

   2. Inactivity or No trips

   3. No click on offer

   4. Lost User Engagement Alert

Creating and Configuring Webhooks

To create and configure a webhook, publishers need to perform the following tasks:

1. Log in to the IQL Publisher Portal.

2. In the left pane, open the Configurations->Webhooks page, as shown below:

1. Click the CREATE NEW WEBHOOK button on the top-right corner of the page. You will see the Webhooks >Create page, as shown below:

1. Select the type of engagement webhook you want to create. You can choose either Milestone Based or Activity Based webhook. In the above screenshot, we have selected a Milestone Based webhook.

2. Now select the Webhook Subtype. Note that the subtype selection is mandatory.

3. Select the appropriate value for the Webhook Subtype. This is also a mandatory selection.

4. Click the PUBLISH button to publish the webhook. If no other webhook with the same configuration exists, you will see the Confirm Publish window, as shown below:

1. Click the PUBLISH button on the Confirm Publish window to publish the webhook you have created.

2. You will see your newly-created webhook listed in the Webhooks page, as shown below:

Viewing, Editing and Pausing a Webhook

The Webhooks page lists all the webhooks that have been created. You can edit or change a webhook's status as highlighted in the following screenshot:

1. Viewing Webhook Details

You can view the details of a webhook by clicking the down-pointing arrow next to it, as shown below:

2. Viewing Webhook Logs

In the Webhooks page, click the View link next to a webhook to see the webhook's logs, as shown below:

You will be able to view all changes, such as the editor's user name, the field name, time of change, and the date(s) when the changes were made.

3. Editing Webhook Details

To edit a webhook, click the Edit link next to a webhook that you want to edit. You will see the Edit Webhook page, as shown below:

4. Pausing a Webhook

You can pause a webhook that is live and make your edits. Any changes you make to the webhook will be published when the webhook is live again.

Webhook Statuses

The Status column in the webhook page displays one of the following status against a webhook in the list:

• Live: This status indicates that the webhook is running in production.

• Paused: This status indicates that the webhook has been paused.