Add event notification account

Lets you integrate a Webhook account to the Capillary system.

To create a new event notification, follow these steps.

  1. Log on to InTouch of your cluster and navigate to Profile icon > Organization Settings > Event Notifications.
1336
  1. Click New notification.
615
  1. In Webhook name, specify a name for the event notification.
  2. In Webhook URL, enter the Webhook URL that you want to associate with the event notification. To get a Webhook URL, you need to have a Webhook account. You can use the URL generated for the account to configure event notifications.
  3. In Header, enter the required headers (for integration authentication) as keys and values required to authenticate event notification.
513
  1. In Payload enrichment settings, select the entries that you want to capture in the current notification. This provides better data enrichment by including the selected entry parameters in the payload.
380
  • Select Till to capture till details - till data enrichment. The payload will contain till details such as till code, till name, and till ID.
  • Select Store to capture store details - store data enrichment. The payload will contain store details such as store name, store ID, store code, and store external ID.
  • Select Customer identifier to capture customer identifiers according to the selected source - customer data enrichment. You will see the Source drop-down as shown in the following screenshots. Select the source identifier that you want to capture.
760 801
  1. In Advanced Settings, you can configure the following.
725
  • Maximum allowed connections: Set the maximum number of concurrent webhook calls that could be allowed.
  • Delivery SLA (in seconds): Set the expected delivery time of the event notification in seconds. This is used to track notifications that took more time than the SLA set.
  1. In Add Events, click + Select events to add events to the notification and click Done. Use the Search box to easily find the event.
298
  • To see the payload of a specific event click the respective > icon (highlighted in the preceding screenshot).
{
   "allOf":[
      {
         "$ref":"commonEvent.json"
      }
   ],
   "javaInterfaces":[
      "com.capillary.eventNotification.bo.BaseEvent"
   ],
   "$schema":"http://json-schema.org/draft-06/schema#",
   "extends":{
      "$ref":"commonEvent.json"
   },
   "name":"pointsExpired",
   "description":"Schema for Points Expired",
   "type":"object",
   "properties":{
      "eventName":{
         "type":"string",
         "default":"pointsExpired"
      },
      "data":{
         "javaType":"com.capillary.eventNotification.bo.PointsExpiredAttributes",
         "type":"object",
         "required":[
            "customerIdentifiers"
         ],
         "properties":{
            "customerIdentifiers":{
               "$ref":"internal/customer.json"
            },
            "triggeringActivity":{
               "$ref":"internal/triggerActivity.json"
            },
            "loyaltyProgramId":{
               "type":"integer"
            },
            "pointsExpired":{
               "type":"number"
            }
         }
      }
   }
}