Introduction

The Antavo Webhook module enables the automatic interactions between the Loyalty Program and external systems. Webhook messages can be triggered by specific actions taken by customers in the loyalty program and contain specific and customizable customer-related information. These messages are sent to a pre-defined endpoint where the message can be processed and the information be subsequently used for automation in third party systems.

Webhook requests can be processed in parallel in multiple execution threads and this functionality needs to be requested.

Configuration

The Webhook module’s configuration page can be found by clicking on the ‘Modules’ item in the sidebar and searching for “Webhook”, This leads to the ‘Settings’ tab of the page where you can define webhook settings.

Basic settings

• URL: Paste the webhook endpoint your developers set up.

• Timeout: Set a timeout value for the webhook request (optional). When left blank, the default value will be applied, which is 1 second. Make sure you define the timeout value in seconds.

• Content type: The data can be sent in either URL-encoded or in JSON format, whichever is more comfortable for your developer.

• Actions: Set the list of events that will trigger webhook messages. Please divide events by commas (i.e. checkout,profile,social_connect, etc.).

Authentication

The webhook authentication header ensures the security of server-to-server communications and helps to make sure that the webhook data originates from Antavo. By default, the authentication is set to ‘None’ which means that the header will not be added to webhook messages. To enable authentication, select one of the following three authentication methods from the dropdown list, which defines the content and format of the header:

• Basic
  Adds a webhook header of basic auth fields in a Base64 encoded format.

  • Username

  • Password

• AWS
  Adds a full AWS Signature

  • Region

  • Service

  • Access Key ID

  • Access Key Secret

  • Algorithm prefix

  • Vendor key

• AWS-S3
  Adds a full AWS Signature compatible with Amazon Web Services S3 Bucket communications

  • Region

  • Service

  • Access Key ID

  • Access Key Secret

  • Filename format

Be sure to hit the ‘Save’ button before leaving the page.

Testing the webhook

Test the webhook mechanism that is set up with the ‘Test’ button, which you can find on the upper right side of the ‘Settings’ tab. This will allow making sure that the format is correct and that the request is returned without errors.

Webhook log

The Webhook log page helps to keep track of the webhook messages sent by Antavo. Find this page by navigating to the ‘Log’ tab of the module configuration page.

See here the following details of all the webhook messages:

• Date

• Action

• Customer

• Response code

• Status

Filter the webhook messages based on their status code by using the Filter button on the upper right-hand side of the page.

To check the exact request and response, click on the View button next to the relevant webhook message.

In the case that you encounter an error on your webhook endpoint, it’s possible to resend webhook events to cover up the outage. Open the webhook message you want to resend and then click ‘Resend’ on the upper right-hand corner of the page.

From the Exports page, these webhook logs can be exported to a .csv or .psv file.