event Call

Description

Purpose

This endpoint allows you to send information about external events related to specific club members. Loyalty systems use this data to segment members and may automatically perform actions such as awarding points or sending communications.

When to Use

• Report external events such as actions, activities, or milestones.
• Trigger automated workflows or segmentation rules within the loyalty system.

📝 Notes

• The member field is optional but useful for associating the event with specific users.
• The event object must include a type, optional subtype, timestamp, and optionally other relevant payload information.

Request Format

Headers

Name	Type	Required	Description
x-source-type	string	✅	Type of source (POS, Web, etc.)
x-source-name	string	✅	Client or integration system name
x-pos-id	string	✅	Unique POS terminal ID
x-branch-id	string	✅	Branch/location identifier

Body

{
  "member": {
    "phoneNumber": "1234567890"
  },
  "event": {
    "type": "string",
    "subType": "string",
    "dateTime": "2025-06-23T13:29:39.487Z",
    "payload": {},
    "tags": ["string"]
  }
}

Response Format

{
  "status": "success",
  "data": {}
}

Error Example

{
  "status": "error",
  "error": {
    "code": "500",
    "message": "Server error"
  }
}

Related Use Cases

• Logging user app usage (e.g., opened_app, completed_tutorial)
• Triggering personalized communications based on user behavior
• Segmenting users by events like milestone achievements