Create a Webhook

Create a Webhook

Note:

To use Webhooks, clients must first connect with the Services team to turn on Azure service bus per client.

To create a webhook, login in to Kognitiv Loyalty using your username and password.

1. From the Menu, click Settings, and then click Webhooks.

   

2. Click the Create Webhook button.

   

    

3. Complete Step 1 of the creation process by providing the required information, and then click Continue.

   1. Webhook name is a required field

   2. Webhook name may not contain trailing space(s).

   3. Webhook name must be unique (case sensitive) within a KLS client program/environment

   4. Description is an optional field

4. Users must establish the Event Group.

   

   5. Complete Step 2 of the creation process by providing the required information, and then click Continue.

   • Event Group cannot be changed after the webhook has been created.

   • In MVP, the only valid Event Group is "Member Rewards" and is the default selection.

   • Users may not change the default POST value of the HTTP Method attribute. POST is the only value supported and is the default selection.

   • Users may establish or edit Webhook URL

     • Only HTTPS protocol is supported. HTTP is not allowed.

     • URL may include personalization parameter values that are dynamically assigned at run time. Apart from disallowing HTTP, the Webhook URL will not be validated for correctness, format, syntax, or placeholder syntax

   • Users may establish or change OAuth 2.0 credentials

     • Choice/list of valid OAuth 2.0 credentials is re-populated, and includes <None> option

     • Only none or one OAuth 2.0 credential set may be selected for any single webhook

     • OAuth 2.0 credentials can be associated with zero-to-many webhooks

     • User can create API credentials "in-flow" following standard in-flow workflow pattern

   • Users may optionally populate request header content as key/value pairs

     • Zero-to-many key/value pairs are valid. On create, a single empty key/value pair is displayed.

     • The value may include a personalization placeholder value that is dynamically assigned at run time

     • If a key/value pair is configured, a value is required for the key. A value is not required. The key cannot include trailing spaces.

     • Values for keys or values are always trimmed before save.

     • Multiple key/value pairs with the same key value are not allowed.

     • Header value must only include characters specified in a Kognitiv defined whitelist

   • Users may optionally populate request body content

   • No validation is done on this content

   • The body may include personalization placeholder values that are dynamically assigned at run time

   • Users may edit the Personalization attributes of a Webhook using the edit screen

   • 

   6. Review the information provided and click submit.