The Actual Payload

What actually needs to be sent to the HyperPulseX Service?

Example Request Headers:

clientId: [SHARED BY HYPERPULSE SERVICE] 
dateTime: 1741330751135 
hmac: OL4d/Arn3KBJf0QKbVlffAt2RIvH2tkuyEEt8EWPliNMvk8VqqF4y4RedRbfX1+sACwKiyfrmGkdoHzNSvRr9w==

Sample Body (Plain payload for the encRequestMsg):

{
  "event_instance_id": "uniqueAlphaNumericIdPerAPICall",
  "event_type": "STATIC_QR_REFRESH",
  "target_devices": {
    "target_list_type": "USERNAME_BASED", //MID_BASED / TID_BASED / USERNAME_BASED / ALL / SEGMENT_ID_BASED
    "usernames": [
      "username1"
    ] 
  },
  "event_broadcast_schedule": "IMMEDIATE", //IMMEDIATE / SCHEDULED / STAGGERED,
  "max_retention_seconds": 60, //Optional, Default: 60 Seconds
  "event_data": {
    "action_delay_seconds": 60, // MAX: 300 Seconds
     "device_model": "ALL", //optional, Default: true
    "is_silent": true, //optional, Default: true
    "notification": {
      "title": "SQR Refreshed", //Max: 40 characters
      "body": "You look fresh, Your SQR has been refreshed." //Max: 80 characters
    } //optional, Recommended to pass if is_silent: false
  }
}

Root Fields

Field Name	Type	Required	Description
event_instance_id	String	Yes	A unique identifier for the event instance.
event_type	String	Yes	The type of event being triggered. Example: STATIC_QR_REFRESH.
target_devices	Object	Yes	Defines the target devices for the event. See details below.
event_broadcast_schedule	String	Yes	Specifies the event broadcast timing. Options: IMMEDIATE, SCHEDULED, STAGGERED.
event_data	Object	Yes	Contains event-specific data, including optional parameters.
max_retention_seconds	Integer	No	Retention time for the message payload. Wait for the "X" duration if the device is offline at that point of time. Avoid setting higher values to this. Max capped to 100s

target_devices Object

Field Name	Type	Required	Description
target_list_type	String	Yes	Specifies the target method: MID_BASED, TID_BASED, USERNAME_BASED, SEGMENT_ID_BASED or ALL. In case of ALL, the entire acquirer topic clients would recieve the campaign.
tsp_mids	Array	Conditional	Required if target_list_type is MID_BASED. Contains an array of Merchant IDs (MIDs).
tsp_tids	Array	Conditional	Required if target_list_type is TID_BASED. Contains an array of Terminal IDs (TIDs).
usernames	Array	Conditional	Required if target_list_type is USERNAME_BASED. Contains an array of usernames.

event_data Object

Field Name	Type	Required	Description
action_delay_seconds	Integer	Yes	Specifies the delay before execution, max: 300 seconds.
device_model	String	No	Specifies the device model. Options: ALL, P10, P12, DX8000. Default: ALL.
is_silent	Boolean	No	Determines if the event triggers a notification on the device. Default: false.
notification	Object	No	Message to be displayed in case of a notification trigger.

notification Object

Field Name	Type	Required	Description
title	String	Yes	The notification message Title as passed to the device. MaxLength: 40
body	String	Yes	The body of the notification card. MaxLength: 80

Response:

{
    "success": true,
    "data": {
        "campaignId": "5e5e53a6-108a-479f-8389-7b29464a9033",
        "segmentId": "AUTO_45003c2d-af23-486c-8549-64a04d5f45d0"
    }
}

campaignId: Can be used to track all the events that occured for this camoaign .

segmentId: Can be used to target the existing or created cohort to publish something.