Webhooks Dashboard (Draft)

Introduction

This article describes the features of the Webhooks Dashboard, giving basic information on how to use the dashboard to create and manage webhooks. This guide is designed for partners. 

Following sections are included in this guide: 

• Accessing the Webhooks Dashboard
• Webhooks Partner Search
• Managing Webhooks
• Global Webhooks
• Linked Programme Webhooks
• Creating Webhooks
• Updating Webhooks
• Webhook Event Logs
• Deleting Webhooks

Overview

The Webhooks Dashboard allows partners to manage webhooks for their Business Unit. You can create global webhooks or modify existing webhooks that have been set up for a specific program (program-related webhooks).

Accessing the Webhooks Dashboard

Follow the steps below to access the webhooks dashboard: 

1. Login to the Reward Manager
2. Navigate to the menu on the right
3. Where you should select Integrations and then Webhooks Dashboard

You can also access the Webhooks dashboard using the following link: 

Webhook Reward Manager Link

Webhooks Partner Search

There are two types of partners: 

• Channel: partners have access only to their business unit (BU)
• Global: partners can access several or even all of them.

If you are logged in as a global partner, you will be redirected to the partner search.

Using this search, you can search for partners who manage other BUs and log in to their dashboard. In this search, you can search by either the partner's ID (e.g. 12345) or by name.

After you will select the partner and click on search button, you will be redirected to the Dashboard.

Managing Webhooks

Once you select a partner or access the dashboard for your business unit, you will see this dashboard page.

This panel allows you to create and manage webhooks. On this page, you will see two sections—one for Global (partner) webhooks and the other for program related webhooks. Let’s take a closer look at these two sections.

Global Webhooks

This section lists the webhooks you can use for your business module or for all business modules to which you have access. By default, this section is empty so you can create a webhook, by clicking on the Create Webhook button. Global webhooks include certain events that cannot be configured via the program related webhooks. That is the main difference.

Actions you can perform with Global Webhooks:

• Create
• Update
• Delete
• View Event Logs

Linked Programme Webhooks

The Linked Programme Webhooks section displays a list of the webhooks that have been configured in the program via the Integrations Dashboard. These webhooks can only be created from the Integrations Dashboard, but you can manage them from this page.

Actions you can perform with Linked Programme Webhooks:

• Update
• Delete
• View Event Logs

Note: 

As you can see, the actions you can take for both types of webhooks are almost identical. With one exception: program-related webhooks can only be created in the Webhook integration within the Integrations Dashboard.

Creating Webhooks

After you will click on the Create Webhook button, you will be redirected to this page.

This page is the same one you use to create a Webhooks integration in the Integrations Dashboard. However, it includes some events that can only be configured for partners.

Steps to create a new webhook: 

1. On this page, you’ll find the Payload URL and Secret fields, which you must fill out, as they are required.
2. In addition, you must specify the events you want to receive at the data URL you provided. 
3. After you complete the configuring of the webhook, you click on the Add Webhook button and you will be redirected to the Webhooks Dashboard again, where you will see your new webhook.

Updating Webhooks

Steps to update existing webhooks: 

1. If you think to change the events that you select for a webhook, you can check the manage menu, this menu exist for all webhooks on this page
2. When you will click on manage link, you will see the Manage Events in the list of the option.

3. After clicking this link, you will be redirected to the same page you use to create the webhook. But with one exception.
4.  The Payload URL and Secret fields will be disabled, which means you can only modify the events you’ve subscribed to for this webhook, but not the access credentials.

Webhook Event Logs

To track the events we send to the client endpoint, you can use the View Event Logs page. You can access this page from the same management menu you use for all webhooks. On this page, you can search for an event by ID or simply select the event from the list displayed on the page.

Deleting Webhooks

You can delete global webhooks or partner-related webhooks via the Webhooks Dashboard by clicking the Delete button in the webhook Manage menu.