The Export Event API enables real-time integration between Como Sense and 3rd-party products using webhooks. Webhooks deliver instant payload notifications as events occur on the Como Sense platform.

Table of Contents

When to Use

Use the Export Event API when external 3rd-party systems need real-time data streaming regarding member activities within the Como Sense platform. Common use cases include:

Syncing loyalty member registrations, consents, and profile updates immediately with external CRM or customer platforms.
Triggering real-time notifications or external workflow actions based on member transactions, benefit redemptions, or punch-card updates.
Auditing and tracking member tag operations or marketing SMS opt-out preferences.

How to Use (Communication & Protocol)

To receive webhook payloads from Como Sense, set up a public web server that satisfies the following criteria:

Protocol: Must be a public web server secured with a valid SSL certificate.
HTTP Method: The endpoint must accept POST requests.
Asynchronous Processing: To prevent timeouts, your server should acknowledge and respond to webhook event notifications prior to executing internal heavy processing logic.

⚠️ Warning: Como will disable your endpoint if invalid responses are received from your server over consecutive days.

Configuration & Throughput Settings

A configurable throughput input (events per second) is available in the Export Event within the Hub under rule action settings. This setting accepts only integer values.

On save, the Hub updates this rate and appends it as a throughput query parameter to the regenerated endpoint URL to regulate outgoing payload rates.

ℹ️ Info: Ensure the throughput value entered strictly contains an integer (e.g., 100). Floating numbers or non-numeric characters will not be accepted.

Export Event Throughput Configuration UI

General Guidelines

Monetary Values

All monetary values (such as TotalSum, Price, etc.) in event payloads follow these rules:

Represented in the smallest unit of currency (e.g., in cents rather than dollars).
Positive values refer to a price or an amount paid by the customer.
Negative values refer to a discount for the customer.

Date Standard and Format

All dates and timestamps adhere to the ISO 8601 standard:

Date Format: yyyy-MM-dd
DateTime Format: yyyy-MM-ddThh:mm:ssZ (where Z indicates UTC+00)

Event Webhook Payloads

Payload Format

The webhook payload is formatted as a JSON object, with the payload body containing all event-related details.

📝 Note: This operation does not support multiple customers in a single batch; only a single event per customer will be sent per HTTP request.

Properties

Field	Description	Type	Returned
Name	Human-readable description of the configured rule.	String	Always
TimeStamp	Epoch time in business local time of when this event HTTP request was sent.	Long	Always
Trigger	The name of the event which triggered this HTTP request (constant value from Como server).	String \| Trigger	Always
Data	An object holding all relevant data related to the specific event (e.g., membership details, purchase details).	Object \| Data	Always

Data Object Properties

Below is a partial list of properties that can be included inside the Data object:

Field	Description	Type	Returned
BusinessName	The business name as it appears in the Como dashboard.	String	Always
LocationID	Como's internal identifier for the business.	String	Always
MembershipKey	Como's internal identifier for the member. Can be used for querying using the Como API.	String	Always
Membership	An object that holds detailed properties related to the member.	Object	Always
UserAction	An object that holds detailed properties related to the specific event (e.g., source details, specific values changed).	Object	Always
Purchase	An object that holds detailed properties related to the purchase (e.g., event source details, items, totals).	Object	Sometimes
Asset	An object that holds detailed properties related to the redeemed asset.	Object	Sometimes
membershipUrl	URL linked to Como's registration form for completing registration and approving T&Cs.	String	Sometimes

Type of Events (Triggers)

The following trigger names represent specific event actions generated on the platform:

Name	Description
`joinedclub`	Member joins the loyalty program.
`GaveConsent`	Member consented to T&Cs.
`openedclub`	Member uses the app after joining the loyalty program.
`purchase`	Member makes a purchase.
`redeem`	Member redeems a Como benefit (gift, punch-card, promo code).
`punch`	Member receives a stamp on his punch-card.
`PointTransaction`	Member uses/earns Como Points/Credit.
`tag_operation`	Member is tagged/untagged.
`UpdateMembership`	Member updates his membership details.
`smsunsubscribe`	Member unsubscribes from opt-in marketing SMS.

Payload Examples

1. `joinedclub`

{
  "Name": "Registered to Como [TEST via API]",
  "TimeStamp": 1627388226835,
  "Trigger": "joinedclub",
  "Data": {
    "RegionIsoCode": "US",
    "BusinessName": "Como Integration",
    "BusinessLogo": "https://keeprzapp.s3.amazonaws.com/photos/8404/original/1598274111_3174776555f43ba3fcbd608.36621389.png",
    "UserKey": "ettHtx9CAug9CC51m47SVV1bvu32CUx90kWYJTESBA88",
    "LocationID": "1111",
    "MembershipKey": "X9AAsnAR1n9DRnzD5909Az9CuEXLmT74s19ADzK1qLve4eUIO47SBV1L48",
    "CurrencyIsoCode": "USD",
    "TimeStamp": "27.07.2021 12:17:06",
    "Source": "QuickRegistration",
    "MemberAssets": [],
    "CurrencySymbol": "$",
    "UserAction": {
      "Action": "joinedclub",
      "TransactionSourceName": "test",
      "ApiKey": "xxxxxxx",
      "TransactionSource": "External",
      "LastUpdate": "27.07.2021 12:17:06",
      "UserKey": "ettHtx9CAug9CC51m47SVV1bvu32CUx90kWYJTESBA88",
      "LocationID": "1111",
      "Data": {
        "Membership": {
          "Status": "ok",
          "MembershipStatus": "registered",
          "Email": "pos@como.com",
          "LastUpdate": "27.07.2021 12:17:06",
          "FirstName": "Como",
          "GenericString3": "IN Midtown",
          "UserKey": "ettHtx9CAug9CC51m47SVV1bvu32CUx90kWYJTESBA88",
          "GenericString2": "Sampling",
          "LocationID": "1111",
          "ConsentForHub": "previous",
          "EntityId": "5370121023553536",
          "comoMemberID": "2f7f85ac-f3da-49ef-babc-64a7ef1dc1e4",
          "CommonExtID": "ba2ae5cb-706c-4545-9031-df6ec3ba664a",
          "Consent": "existing",
          "Assets": "[]",
          "Kind": "UserAtLocation",
          "PhoneNumber": "0501234567",
          "CreatedOn": "27.07.2021 12:17:06",
          "LastName": "Test",
          "RegistrationSource": "QuickRegistration",
          "AllowSMS": "true",
          "Key": "XBAAsnAR1n9DRnzD5909Az9CuEXLmT74s19ADzK1qLve4eUIO47SBV1L48",
          "ComoMemberID": "2f7f85ac-f3da-49ef-babc-64a7ef1dc1e4"
        }
      },
      "Verification": "server",
      "Labels": {},
      "MembershipKey": "X9AAsnAR1n9DRnzD5909Az9CuEXLmT74s19ADzK1qLve4eUIO47SBV1L48",
      "Public": "false",
      "TimeStamp": "27.07.2021 12:17:06",
      "Source": "QuickRegistration",
      "Kind": "UserAction",
      "CreatedOn": "27.07.2021 12:17:06",
      "Key": "z56aCnLTOWLV00ztUNQthAppn9BADM2udzQII25rK90zhqmg88",
      "TimeZone": "America/New_York",
      "TextDirection": "ltr"
    },
    "Rule": {
      "ID": "automation_8d175bf0",
      "Tag": "automation_8d175bf0"
    },
    "membershipUrl": "https://ptcy.com/551EPMUD8"
  }
}

2. `GaveConsent`

{
  "Name": "Consented to TAC",
  "TimeStamp": 1620731884939,
  "Trigger": "GaveConsent",
  "Data": {
    "RegionIsoCode": "GB",
    "BusinessName": "Como Integration",
    "BusinessLogo": "https://static-prod.como.com/photos/7976/original/1620637878_9555996796098f596663206.16619393.png",
    "UserKey": "101VxS20yB2098WfG9Cyxj1c4CNGy12A09CcqneEA88",
    "LocationID": "1111",
    "MembershipKey": "ddZCshp7tQp9B41SVCVXE34j9AZdRCodcOPnSo2BFHebHjGkp9Du008",
    "CurrencyIsoCode": "GBP",
    "TimeStamp": "11.05.2021 11:16:44",
    "Source": "LandingPage",
    "CurrencySymbol": "£",
    "UserAction": {
      "Action": "GaveConsent",
      "LastUpdate": "11.05.2021 11:16:44",
      "UserKey": "101VxS20yB2098WfG9Cyxj1c4CNGy12A09CcqneEA88",
      "LocationID": "1111",
      "Data": {
        "OldValue": "no",
        "NewValue": "yes"
      },
      "Verification": "server",
      "Labels": {},
      "MembershipKey": "ddZCshp7tQp9B41SVCVXE34j9AZdRCodcOPnSo2BFHebHjGkp9Du008",
      "Public": "false",
      "TimeStamp": "11.05.2021 11:16:44",
      "Source": "LandingPage",
      "Kind": "UserAction",
      "CreatedOn": "11.05.2021 11:16:44",
      "Key": "3T60G0LJHXL15rz9BYNQ9BrBpSr-eldVVW16htRh7zvH15Kug88",
      "TimeZone": "Asia/Jerusalem",
      "TextDirection": "ltr"
    },
    "Membership": {
      "MembershipStatus": "registered",
      "AccumulatedPoints": "0",
      "Email": "pos@como.com",
      "LastUpdate": "11.05.2021 11:16:44",
      "BudgetWeighted": "512800",
      "UserKey": "101VxS20yB2098WfG9Cyxj1c4CNGy12A09CcqneEA88",
      "LocationID": "1111",
      "comoMemberID": "18b1097d-85d2-4a61-b4e3-16c495fac696",
      "Points": "312800",
      "AllowEmail": "true",
      "Consent": "yes",
      "Assets": [],
      "Kind": "UserAtLocation",
      "CreatedOn": "11.05.2021 11:06:21",
      "RegistrationSource": "AutoRegistration",
      "WeightedPoints": "312800",
      "AllowSMS": "true",
      "UnweightedBudgetPoints": "0",
      "Status": "ok",
      "FirstName": "Como",
      "ConsentForHub": "yes",
      "EntityId": "6706489628270592",
      "CommonExtID": "800a2deb-212d-4b42-a9e3-29f632791298",
      "PhoneNumber": "0501234567",
      "LastName": "Test",
      "Tag": [
        "1stPurchase"
      ],
      "BudgetAccumulatedUnweighted": "0",
      "BudgetUnweighted": "0",
      "BudgetAccumulatedWeighted": "512800",
      "Key": "ddZCshp7tQp9B41SVCVXE34j9AZdRCodcOPnSo2BFHebHjGkp9Du008",
      "ComoMemberID": "18b1097d-85d2-4a61-b4e3-16c495fac696"
    },
    "Rule": {
      "ID": "automation_ab68afb1",
      "Tag": "automation_ab68afb1"
    }
  }
}

3. `purchase`

{
  "Name": "Makes a purchase",
  "TimeStamp": 1620732414571,
  "Trigger": "purchase",
  "Data": {
    "BusinessLogo": "https://static-prod.como.com/photos/7976/original/1620637878_9555996796098f596663206.16619393.png",
    "UserKey": "IepWx16PyR6R98mjH9DDFJk9AkCQGid1AtEdKjeEg88",
    "LocationID": "1111",
    "BranchID": "67",
    "Source": "POS",
    "CurrencySymbol": "£",
    "UserAction": {
      "Action": "purchase",
      "TransactionSourceName": "Virtual POS",
      "ApiKey": "xxxxxxxx",
      "TransactionSource": "POS",
      "LastUpdate": "11.05.2021 11:26:50",
      "UserKey": "IepWx16PyR6R98mjH9DDFJk9AkCQGid1AtEdKjeEg88",
      "PurchaseUID": "52559d4d-3d97-4fef-a50c-8c8dc539f308",
      "LocationID": "7976",
      "Data": {
        "TransactionSourceVersion": "1.2.3",
        "TransactionSourceName": "Virtual POS",
        "ApiKey": "xxxxxxx",
        "TransactionSource": "POS",
        "RelativeSum": "7060",
        "BranchID": "67",
        "Source": "POS",
        "TransactionID": "66417",
        "NumOfMembers": "1",
        "PosID": "89",
        "PurchaseKey": "LS09AbNQ1b79A0pg1x0kWqCT53reIY5X9C37CJZ19AL3LF48",
        "TotalSum": "7060",
        "MemberIndex": "0",
        "UsedGeneralMembership": "N",
        "Confirmation": "LS09AbNQ1b79A0pg1x0kWqCT53reIY5X9C37CJZ19AL3LF48"
      },
      "Verification": "server",
      "Labels": {},
      "MembershipKey": "ddZCshp7tQp9B41SVCVXE34j9AZdRCodcOPnSo2BFHebHjGkp9Du008",
      "Public": "false",
      "BranchID": "67",
      "TimeStamp": "11.05.2021 11:26:50",
      "Source": "POS",
      "TransactionID": "66417",
      "PosID": "89",
      "PurchaseKey": "LS09AbNQ1b79A0pg1x0kWqCT53reIY5X9C37CJZ19AL3LF48",
      "Kind": "UserAction",
      "CreatedOn": "11.05.2021 11:26:50",
      "Key": "20mlFx3eGG3gRbF49A9A4pxVqdw5Qneu5BZ1e7PjGEyAsA88",
      "TextDirection": "ltr"
    },
    "Membership": {
      "MembershipStatus": "registered",
      "AccumulatedPoints": "0",
      "Email": "pos@como.com",
      "LastUpdate": "11.05.2021 11:26:54",
      "BudgetWeighted": "512740",
      "UserKey": "IepWx16PyR6R98mjH9DDFJk9AkCQGid1AtEdKjeEg88",
      "LocationID": "1111",
      "comoMemberID": "18b1097d-85d2-4a61-b4e3-16c495fac696",
      "Points": "292800",
      "AllowEmail": "true",
      "Consent": "yes",
      "Assets": [],
      "Kind": "UserAtLocation",
      "CreatedOn": "11.05.2021 11:06:21",
      "RegistrationSource": "AutoRegistration",
      "WeightedPoints": "312800",
      "AllowSMS": "true",
      "UnweightedBudgetPoints": "20000",
      "Status": "ok",
      "FirstName": "Como",
      "ConsentForHub": "yes",
      "PreviousUserKeys": [
        "101VxS20yB2098WfG9Cyxj1c4CNGy12A09CcqneEA88"
      ],
      "EntityId": "6706489628270592",
      "CommonExtID": "800a2deb-212d-4b42-a9e3-29f632791298",
      "PhoneNumber": "0501234567",
      "LastName": "Test",
      "Tag": [
        "1stPurchase",
        "2ndPurchase"
      ],
      "BudgetAccumulatedUnweighted": "0",
      "BudgetUnweighted": "7060",
      "BudgetAccumulatedWeighted": "519860",
      "Key": "ddZCshp7tQp9B41SVCVXE34j9AZdRCodcOPnSo2BFHebHjGkp9Du008",
      "ComoMemberID": "18b1097d-85d2-4a61-b4e3-16c495fac696"
    },
    "RegionIsoCode": "GB",
    "BusinessName": "Como_Integration",
    "RelativeSum": "7060",
    "MembershipKey": "ddZCshp7tQp9B41SVCVXE34j9AZdRCodcOPnSo2BFHebHjGkp9Du008",
    "CurrencyIsoCode": "GBP",
    "TimeStamp": "11.05.2021 11:26:50",
    "TimeZone": "Asia/Jerusalem",
    "NumOfMembers": "1",
    "TotalSum": "7060",
    "Rule": {
      "ID": "automation_3f513800",
      "Tag": "automation_3f513800"
    },
    "Confirmation": "LS09AbNQ1b79A0pg1x0kWqCT53reIY5X9C37CJZ19AL3LF48"
  }
}

4. `redeem`

{
  "Name": "Redeems a benefit",
  "TimeStamp": 1620732411562,
  "Trigger": "redeem",
  "Data": {
    "RegionIsoCode": "GB",
    "BusinessName": "Como_Integration",
    "BusinessLogo": "https://static-prod.como.com/photos/7976/original/1620637878_9555996796098f596663206.16619393.png",
    "UserKey": "IepWx16PyR6R98mjH9DDFJk9AkCQGid1AtEdKjeEg88",
    "LocationID": "1111",
    "MembershipKey": "ddZCshp7tQp9B41SVCVXE34j9AZdRCodcOPnSo2BFHebHjGkp9Du008",
    "CurrencyIsoCode": "GBP",
    "TimeStamp": "11.05.2021 11:26:53",
    "Source": "POS",
    "MemberAssets": [
      {
        "template": "smartAsset_4ef7becc",
        "type": "gift",
        "key": "I71C9AL1fIL3DJVrsvlsP9AMlnebzgI6bJ9DYCz53rN48",
        "status": "Active"
      },
      {
        "template": "smartAsset_92144adc",
        "type": "punch_card",
        "key": "7k9C7K5PBLm0iVbou.jcH5MwKZygExZ5zVD09B2rWw8",
        "status": "In Progress"
      },
      {
        "template": "smartAsset_d1b9f507",
        "type": "gift",
        "key": "6ku33490KmveUbYq1b90131mQxfUpWY9DD9C.JNrot08",
        "status": "Active"
      }
    ],
    "CurrencySymbol": "£",
    "UserAction": {
      "Action": "redeem",
      "TransactionSourceName": "Virtual POS",
      "ApiKey": "xxxxxxxx",
      "TransactionSource": "POS",
      "LastUpdate": "11.05.2021 11:26:51",
      "UserKey": "IepWx16PyR6R98mjH9DDFJk9AkCQGid1AtEdKjeEg88",
      "LocationID": "1111",
      "Data": {
        "ExternalBenefits": [
          {
            "AssetTemplateKey": "9B1FDM5v9ANnfqXc121cv7LmaYzgM9AdajeEbt9CtOw8",
            "AppliedAmount": "500",
            "RedeemLock": "7976-67-89-66417-1628731182000",
            "AssetName": "5£ off Gift | Point Shop",
            "Result": "Y",
            "MatchTypeMembershipKey": "Join",
            "AssetType": "gift",
            "OwningMembers": [
              "ddZCshp7tQp9B41SVCVXE34j9AZdRCodcOPnSo2BFHebHjGkp9Du008"
            ],
            "AssetKey": "9B1FDM5v9ANnfqXc121cv7LmaYzgM9AdajeEbt9CtOw8",
            "AssetTemplate": "smartAsset_fd00c8e4",
            "InvokingMembershipKey": "ddZCshp7tQp9B41SVCVXE34j9AZdRCodcOPnSo2BFHebHjGkp9Du008",
            "ContextData": {},
            "MatchFoundMembershipKey": "true"
          }
        ]
      },
      "Verification": "server",
      "Labels": {},
      "MembershipKey": "ddZCshp7tQp9B41SVCVXE34j9AZdRCodcOPnSo2BFHebHjGkp9Du008",
      "Public": "false",
      "BranchID": "67",
      "TimeStamp": "11.05.2021 11:26:51",
      "Source": "POS",
      "TransactionID": "66417",
      "AssetKey": "9B1FDM5v9ANnfqXc121cv7LmaYzgM9AdajeEbt9CtOw8",
      "PosID": "89",
      "Kind": "UserAction",
      "CreatedOn": "11.05.2021 11:26:51",
      "Key": "68y4K3DxK40zsMolbu7LuiHu90IpWo469AyxknNUXPGY11888",
      "TimeZone": "Asia/Jerusalem",
      "TextDirection": "ltr"
    },
    "Asset": {
      "AssetSource": "POS",
      "Type": "gift",
      "Key": "9B1FDM5v9ANnfqXc121cv7LmaYzgM9AdajeEbt9CtOw8",
      "Template": "smartAsset_fd00c8e4"
    },
    "Membership": {
      "MembershipStatus": "registered",
      "AccumulatedPoints": "0",
      "Email": "pos@como.com",
      "LastUpdate": "11.05.2021 11:26:45",
      "BudgetWeighted": "505740",
      "UserKey": "IepWx16PyR6R98mjH9DDFJk9AkCQGid1AtEdKjeEg88",
      "LocationID": "1111",
      "comoMemberID": "18b1097d-85d2-4a61-b4e3-16c495fac696",
      "Points": "292800",
      "AllowEmail": "true",
      "Consent": "yes",
      "Assets": [],
      "Kind": "UserAtLocation",
      "CreatedOn": "11.05.2021 11:06:21",
      "RegistrationSource": "AutoRegistration",
      "WeightedPoints": "312800",
      "AllowSMS": "true",
      "UnweightedBudgetPoints": "20000",
      "Status": "ok",
      "FirstName": "Como",
      "ConsentForHub": "yes",
      "PreviousUserKeys": [
        "101VxS20yB2098WfG9Cyxj1c4CNGy12A09CcqneEA88"
      ],
      "EntityId": "6706489628270592",
      "CommonExtID": "800a2deb-212d-4b42-a9e3-29f632791298",
      "PhoneNumber": "0501234567",
      "LastName": "Test",
      "Tag": [
        "1stPurchase"
      ],
      "BudgetAccumulatedUnweighted": "0",
      "BudgetUnweighted": "-7060",
      "BudgetAccumulatedWeighted": "512800",
      "Key": "ddZCshp7tQp9B41SVCVXE34j9AZdRCodcOPnSo2BFHebHjGkp9Du008",
      "ComoMemberID": "18b1097d-85d2-4a61-b4e3-16c495fac696"
    },
    "Rule": {
      "ID": "automation_d95ab107",
      "Tag": "automation_d95ab107"
    }
  }
}

API Docs

Search

Export Event API (Webhooks)

When to Use

How to Use (Communication & Protocol)

Configuration & Throughput Settings

General Guidelines

Monetary Values

Date Standard and Format

Event Webhook Payloads

Payload Format

Properties

Data Object Properties

Type of Events (Triggers)

Payload Examples

1. `joinedclub`

2. `GaveConsent`

3. `purchase`

4. `redeem`

Search

When to Use

How to Use (Communication & Protocol)

Configuration & Throughput Settings

General Guidelines

Monetary Values

Date Standard and Format

Event Webhook Payloads

Payload Format

Properties

Data Object Properties

Type of Events (Triggers)

Payload Examples

1. joinedclub

2. GaveConsent

3. purchase

4. redeem

Related articles

1. `joinedclub`

2. `GaveConsent`

3. `purchase`

4. `redeem`