Offers

All offer events will return the following object. This is the same object as the active offers api returns. API Endpoint

{
  "id": "string",
  "title": "string",
  "text": "string",
  "offerType": "string",
  "startDate": "2025-10-14T03:33:28.490Z",
  "endDate": "2025-10-14T03:33:28.490Z",
  "images": [
    {
      "id": "string",
      "order": 0,
      "url": "string",
      "altText": "string",
      "tag": "string"
    }
  ],
  "merchantName": "string",
  "merchantNumber": "string",
  "isDefault": true,
  "reward": 0,
  "merchantCostPerRewardTypeUnit": 0,
  "rewardType": "string",
  "applicableDays": [
    "string"
  ],
  "dayStartTime": "string",
  "dayEndTime": "string",
  "spendRestrictionType": "string",
  "minimumSpend": 0,
  "maximumSpend": 0,
  "exactSpend": 0,
  "merchantFee": 0,
  "merchantFeeType": "string",
  "budget": 0,
  "budgetThresholdReachedDate": "2025-10-14T03:33:28.490Z",
  "budgetReachedDate": "2025-10-14T03:33:28.490Z",
  "allDay": true,
  "offerTags": [
    "string"
  ],
  "offerPointsTiers": [
    {
      "minPointsTierDollarAmount": 0,
      "maxPointsTierDollarAmount": 0,
      "pointPerDollarAmount": 0,
      "merchantCostPerPoint": 0
    }
  ],
  "restrictions": {
    "restrictToAssignedMembers": true,
    "rewardedVisits": [
      0
    ],
    "allowedMemberTypes": [
      "string"
    ],
    "allowedSchemeChannels": [
      "string"
    ],
    "maxOfferRedemptions": 0
  },
  "createdDate": "2025-10-14T03:33:28.490Z",
  "offerBoosts": [
    {
      "id": 0,
      "offerId": "string",
      "name": "string",
      "displayName": "string",
      "description": "string",
      "startDate": "2025-10-14T03:33:28.490Z",
      "endDate": "2025-10-14T03:33:28.490Z",
      "boostAmount": 0,
      "boostType": "string",
      "fundedBy": "string",
      "status": "string",
      "merchantFee": 0,
      "merchantFeeType": "string"
    }
  ],
  "termsAndConditions": "string",
  "lastClickCategories": [
    {
      "category": "string",
      "rate": 0
    }
  ],
  "offerGroup": "string",
  "merchantGroupCode": "string"
}

Events

offer.platformofferadded - This event will be triggered every time a platform offer type is added.
offer.platformofferupdated - This event will be triggered every time a platform offer type is updated.
offer.programofferadded - This event will be triggered every time a baseline offer is added.
offer.programofferupdated - This event will be triggered every time a baseline offer is updated.
offer.programofferdeleted - This event will be triggered every time a baseline offer is deleted.
offer.baselineofferadded - This event will be triggered every time a baseline offer is added.
offer.baselineofferupdated - This event will be triggered every time a baseline offer is updated.
offer.baselineofferdeleted - This event will be triggered every time a baselined offer is deleted.
offer.baselineofferended - This event will be triggered every time a baseline offer is ended manually.
offer.merchantofferapproved - This event will be triggered every time a merchant offer is approved.
offer.merchantofferended - This event will be triggered every time a merchant offer is ended manually.
offer.campaignacceptedbymerchant - This event will be triggered every time a campaign offer invitation is accepted by a merchant.
offer.offerbudgetthresholdreached - This event will be triggered when an offer has reached 90% or more of its budget.
offer.offerbudgetreached - This event will be triggered when an offer has reached 100% of its budget.
offer.boostaddedforoffer - This event will be triggered every time a boost is added for an offer.
offer.boostupdatedforoffer - This event will be triggered every time a boost for an offer is updated.
offer.boostendedforoffer - This event will be triggered every time a boost for an offer is ended.
offer.boostdeletedforoffer - This event will be triggered every time a boost for an offer is deleted.

Events​

Events