Event Contexts

An Event Context is the payload Omneo provides when an event fires, delivered through a webhook or a reaction. It differs from a standard API response: it includes enriched, related data alongside the triggering object so your handler can act without making extra API calls back to Omneo. The same context drives both surfaces. A webhook delivers the raw context as its request body. A reaction exposes every field in the context as a variable for filters and target templates.

Why contexts differ from API responses

A standard GET /api/v3/profiles/{id} response returns the profile object. The profile context sent with a profile.updated event also includes:

Aggregations (spend_12m, shop_count, and more)
flattened_tags and flattened_statuses (flat arrays for easier JSON Logic evaluation)
The current tier and its progress
Profile attribute objects (comms, appearance, dates)
Balances, identities, addresses, and preferred and joined location and staff

Your handler can act on the event without a follow-up call for these related objects.

How a context is built

Every context follows the same shape: the base object for the resource, plus a small set of event-specific keys.

Suffix	Payload
`.created`	The full base object.
`.updated`	The full base object, plus `changes` and `originals`.
`.deleted`	Identifiers only, not the full object. The exact keys vary by resource, but always enough to locate the record you already hold.

changes and originals describe what an update altered:

changes holds the fields that changed, with their new values.
originals holds the same fields with their previous values.

{
  "id": "8fc344db-713e-4590-ab26-e82d77ba3313",
  "email": "jane.smith@example.com",
  "changes": { "email": "jane.smith@example.com", "tier_handle": "gold" },
  "originals": { "email": "jane@example.com", "tier_handle": "silver" }
}

Not every .updated event carries both keys. Some carry changes only, and a few (such as credit.updated) carry the full object with no change record. The event reference states which applies per event.

The `requested_by` object

Most contexts also include a requested_by object describing the API token that caused the event. Use it in conditions to skip events your own integration triggered. It can be null for events raised by internal platform processes. See Filtering by event source.

Profile fields can be omitted from a context by tenant configuration. If a profile attribute you expect is absent, check whether it has been excluded for the tenant.

Event reference

Every event below can be used as a webhook trigger or a reaction trigger. Events that share an identical context are listed together, for example credit.updated | credit.extended | credit.released. “Full object” means the base object for that resource, documented under Detailed payloads for the common ones.

Profiles and identity

Event	Context payload
`profile.created`	Full profile object.
`profile.updated`	Full profile object, plus `changes` and `originals`. Also raised when a profile’s `comms` or `appearance` attributes change.
`profile.merged`	Full profile object of the surviving profile, plus `changes` and `originals`.
`profile.deleted`	Identifiers only: `id`, `email`, `identities`, and `is_purged`. For a delete caused by a merge, `is_merged` is `true` and a `merged_to_profile_id` identity records both IDs.
`identity.created`	Full profile object, plus the new `identity`.
`balance.updated`	The profile’s balances (`reward_balance`, `point_balance`, `benefit_balance`, `combined_balance_dollars`, and localised values) with the `profile`.
`address.created`	Full address object.
`address.updated`	Full address object, plus `changes` and `originals`.
`profile.address.deleted`	Identifiers only: `id`, `profile_id`, `is_default`, `external_id`, `custom_fields`.
`attributes.date.created` `attributes.date.updated` `attributes.date.deleted` `attributes.date.linked` `attributes.date.unlinked`	The profile date attribute, with the `profile` and, for linked dates, the `link_profile`.
`custom-field.created`	Full custom field object.
`custom-field.updated`	Full custom field object, plus `changes`.
`custom-field.deleted`	Identifiers only: `handle`, `namespace`, `resource_owner_id`, `resource_owner_type`.

Transactions and orders

Event	Context payload
`transaction.created`	Full transaction object, plus `is_claimed`.
`transaction.updated`	Full transaction object, plus `changes` and `originals`.
`transaction.deleted`	Identifiers only: `id`, `profile_id`.
`transaction.resent`	Full transaction object, plus `resend`.
`transaction.points.issued`	Full transaction object, plus `total_points` and `total_points_value`.
`transaction.tier-points.issued`	Full transaction object.
`transaction-item.created` `transaction-item.sync`	Full transaction item object.
`transaction-item.resent`	Full transaction item object, plus `resend`.
`transaction-claim.claimed` `transaction-claim.failed`	The claim, with the `profile`, the matched transaction summary, and `claimed_transaction`.
`order.created`	Full order object.
`order.updated`	Full order object, plus `changes` and `originals`.
`order.deleted`	Identifiers only: `id`, `profile_id`.
`order.resent`	Full order object, plus `resend`.
`order-item.created`	Full order item object.

Incentives

Event	Context payload
`reward.created`	Full reward object.
`reward.updated` `reward.extended`	Full reward object, plus `changes`.
`reward.deleted`	Identifiers only: `id`, `profile_id`.
`benefit.created`	Full benefit object.
`benefit.updated` `benefit.code.allocated`	Full benefit object, plus `changes` and `originals`.
`benefit.deleted` `benefit.expired`	Identifiers only: `id`, `profile_id`, `definition`, `has_redemptions`, `redemption_items`.
`credit.created`	Full credit object.
`credit.updated` `credit.extended` `credit.released`	Full credit object.
`credit.deleted`	Identifiers only: `id`, `profile_id`, `creator_profile_id`.
`point.created`	The point instance: `value_initial`, `value_remaining`, `profile_id`, `definition_handle`, `issued_at`, `status`, and source.
`redemption.created`	The redemption, with the `profile` and its incentive flags (`has_reward`, `has_benefit`, `has_credit`, `has_point`).
`reward-definition.created` `reward-definition.updated`	Full reward definition object.
`benefit-definition.created`	Full benefit definition object.
`benefit-definition.updated`	Full benefit definition object, plus `changes`.
`benefit-definition.deleted`	Identifiers only: `id`, `handle`.
`point-definition.created`	Full point definition object.
`point-definition.updated`	Full point definition object, plus `changes`.
`point-definition.deleted`	Identifiers only: `id`, `handle`.

Tiers and achievements

Event	Context payload
`tier.achieved` `tier.maintained`	Full tier object, including the `profile`, `definition`, and `progress`.
`tier.progressed`	Full tier object, plus the `tier_point` that caused the progress when present.
`tier.switched`	The `new` and `old` tier definitions.
`tier.lost`	The `profile`, the `new` tier, and the `lost` tier definition.
`tier-point.created`	Full tier object for the profile whose tier points changed.
`achievement.unlocked`	`profile_id`, the `level` reached, and the achievement `definition`.
`tier-definition.created`	Full tier definition object.
`tier-definition.updated`	Full tier definition object, plus `changes`.
`tier-definition.deleted`	Identifiers only: `id`, `handle`.

Lists, products, ratings, and interactions

Event	Context payload
`product-list.created`	Full product list object.
`product-list.updated`	Full product list object, plus `changes` and `originals`.
`product-list.deleted`	Identifiers only: `id`, `profile_id`, `name`, `handle`, `list_definition_id`.
`product-list-item.created`	Full product list item object.
`product-list-item.updated` `product-list-item.linked`	Full product list item object, plus `changes` and `originals`.
`product-list-item.deleted`	Identifiers only: `id`, `product_list_id`, `product_id`, `product_variant_id`, `custom_product_id`, `product_category_id`.
`product-list-share.created`	Full product list share object.
`product-list-share.deleted`	Identifiers only: `id`, `handle`, `profile_id`, `deleted_at`.
`product-list-reservation.created` `product-list-reservation.updated`	Full product list reservation object.
`product-list-reservation.deleted`	Identifiers only: `id`, `profile_id`, `product_list_item_id`, `product_list_id`.
`list-definition.created` `list-definition.updated`	Full list definition object.
`product.created` `product.deleted`	Full product object.
`product.updated`	Full product object, plus `changes` and `originals`.
`rating.created`	Full rating object, including the linked `transaction` when one exists.
`rating.updated`	Full rating object, plus `changes` and `originals`.
`interaction.created`	The interaction, with a light `profile` summary and the resolved `interacted` object.
`share.created` `share.updated` `share.deleted`	The share, with its resolved `source` object.

Appointments

Event	Context payload
`appointment.created` `appointment.confirmed` `appointment.arrived` `appointment.completed` `appointment.cancelled` `appointment.rejected` `appointment.no_show`	Full appointment object, including the `profile`.
`appointment.updated`	Full appointment object, plus `changes` and `originals`.
`appointment.deleted`	Identifiers only: `id`, `status`, `profile_id`.
`appointment_definition.created`	Full appointment definition object.
`appointment_definition.updated`	Full appointment definition object, plus `changes` and `originals`.
`appointment_definition.deleted`	Identifiers only: `id`, `handle`, `name`.
`appointment_queue.created` `appointment_queue.called` `appointment_queue.served` `appointment_queue.cancelled` `appointment_queue.updated`	Full appointment queue object.
`appointment_queue.deleted`	Identifiers only: `id`, `status`.
`appointment_waitlist.created` `appointment_waitlist.fulfilled` `appointment_waitlist.expired` `appointment_waitlist.cancelled` `appointment_waitlist.updated`	Full appointment waitlist object.
`appointment_waitlist.deleted`	Identifiers only: `id`, `profile_id`, `status`.

Groups and connections

Event	Context payload
`group.profile.add` `group.profile.remove`	`group_definition`, `profile_id`, `owner_profile_id`, `record_type`, and the backing `record`.
`group_definition.created` `group_definition.updated`	Full group definition object.
`group_definition.deleted`	Identifiers only: `id`, `handle`, `name`, `type`.
`connection.created`	Full connection object.
`connection.updated`	Full connection object, plus `changes`.
`connection.deleted`	Identifiers only: `id`, `connected_id`, `connector_id`.

Configuration and reference data

Event	Context payload
`location.created`	Full location object.
`location.updated`	Full location object, plus `changes` and `originals`.
`location.deleted`	Identifiers only: `id`, `external_id`, `external_code`, `custom_fields`.
`country.created` `country.updated`	Full country object, including its `states`.
`region.created`	Full region object, including its `countries`.
`region.updated`	Full region object, plus `changes` and `originals`.
`rate.created`	Full rate object.
`rate.updated`	Full rate object, plus `changes` and `originals`.
`notification.created`	The notification schedule: `id`, `send_at`, `schedule_at`, `processed_at`.

A few triggers exist mainly for internal orchestration and are rarely subscribed to directly: profile.before.update, reward.before.notify, aggregation.updated, profile-temporary.created, transaction.received, transaction.sync, transaction.recalculate, and transaction.profile.unattached. They carry the same context as their standard counterpart (for example transaction.received matches transaction.created). Prefer the standard events above.

Detailed payloads

The examples below show representative values, with arrays showing a single element. Every top-level field a context sends is included. Where a field nests another object that is itself a documented context (profile, definition, transaction, items, transactions), the example shows its identifying fields and a note points to the full object. Smaller nested objects that Omneo trims to a fixed set of fields, such as the profile and transaction on a transaction item, are shown in full.

Profile

Sent with profile.created, profile.updated, identity.created, and (in nested form) most events that involve a profile. Profile fields sit at the root of the context.

{
  "id": "8fc344db-713e-4590-ab26-e82d77ba3313",
  "title": "Ms",
  "first_name": "Jane",
  "last_name": "Smith",
  "full_name": "Jane Smith",
  "email": "jane@example.com",
  "gender": "female",
  "currency": "AUD",
  "mobile_phone": "0400123456",
  "mobile_phone_country": "AU",
  "mobile_phone_e164": "+61400123456",
  "mobile_phone_national": "0400 123 456",
  "mobile_phone_national_prefix": "0400123456",
  "secondary_phone": null,
  "birth_year": 1985,
  "birth_month": 9,
  "birth_day": 15,
  "birth_date": "1985-09-15",
  "next_birthday": "2025-09-15",
  "birth_days": 50,
  "birth_days_past": 315,
  "company": null,
  "occupation": "Architect",
  "avatar_url": null,
  "joined_at": "2023-01-15 00:00:00",
  "joined_location_id": 2,
  "preferred_location_id": 2,
  "joined_location": { "id": 2, "name": "Bondi", "type": "store" },
  "preferred_location": { "id": 2, "name": "Bondi", "type": "store" },
  "preferred_staff_id": null,
  "preferred_staff": null,
  "joined_staff_id": null,
  "joined_staff": null,
  "tier_handle": "gold",
  "tier": {
    "handle": "gold",
    "name": "Gold",
    "anniversary_at": "2025-01-15 00:00:00",
    "current_tier_value_min": 1000,
    "current_remain": 250,
    "next_remain": 1550,
    "next_tier": "Platinum",
    "next_tier_handle": "platinum",
    "next_tier_value_min": 4000,
    "current_progress": 61,
    "next_progress": 61
  },
  "tags": [{ "id": 12, "handle": "vip", "created_at": "2024-02-01 09:00:00", "updated_at": "2024-02-01 09:00:00" }],
  "flattened_tags": ["vip", "stylist-client"],
  "flattened_statuses": ["active"],
  "statuses": [{ "id": 1, "handle": "active", "name": "Active" }],
  "identities": [
    { "id": "b1e...", "profile_id": "8fc3...", "handle": "loyalty_card", "identifier": "9876500012", "is_primary": true, "is_active": true, "merged_from": null }
  ],
  "attributes": {
    "comms": { "email_promo": true, "email_optout": false, "sms_promo": false, "email_consent_updated_at": "2024-02-01 09:00:00", "terms_accepted_version": "2.1" },
    "appearance": { "size_top": "12", "size_shoe": "8" },
    "dates": []
  },
  "custom_attributes": { "acme": { "referrer": "in-store" } },
  "address": { "id": "a1c...", "address_line_1": "1 George St", "city": "Sydney", "postcode": "2000", "country": "Australia", "is_default": true },
  "addresses": [{ "id": "a1c...", "address_line_1": "1 George St", "city": "Sydney", "is_default": true }],
  "reward_balance": 25.00,
  "point_balance": 1500,
  "benefit_balance": 2,
  "credit_balance": 0,
  "combined_balance_dollars": 40.00,
  "point_balance_dollars": 15.00,
  "aggregations": {
    "spend_12m": 2450.00,
    "spend_all": 12800.00,
    "spend_atv_12m": 175.00,
    "shop_count": 14,
    "shop_days": 12,
    "spend_last_date": "2025-06-15",
    "most_spend_location": 2
  },
  "region": { "id": 1, "handle": "au", "name": "Australia", "is_active": true },
  "regions": [{ "id": 1, "handle": "au", "name": "Australia" }],
  "normal_hours": [],
  "special_hours": [],
  "is_completed": true,
  "is_public": false,
  "profile_type": "customer",
  "created_by": null,
  "created_at": "2023-01-15 00:00:00",
  "updated_at": "2025-06-15 14:35:00"
}

The comms object carries the full consent matrix. Alongside the fields shown, each channel (email, sms, push, phone, post) has _optout, _bounced, _promo, and per-purpose flags (_discover, _benefits, _reminders, _account, _bookings, _feedback, _location, _service), each with a matching _raw value.

profile.created and profile.updated are not delivered for incomplete profiles (is_completed is false) or system profile types. See Delivery behaviour.

Transaction

Sent with transaction.created and transaction.updated. The profile is nested under profile, so condition paths become profile.tier_handle, profile.aggregations.spend_12m, and so on.

{
  "id": "txn-uuid",
  "external_id": "ORDER-10334",
  "profile_id": "profile-uuid",
  "staff_id": null,
  "staff": null,
  "location_id": 2,
  "location": { "id": 2, "name": "Bondi", "type": "store" },
  "currency_id": 1,
  "currency": "AUD",
  "total": 149.95,
  "total_original": 199.95,
  "total_converted": 149.95,
  "is_void": false,
  "currency_rate": 1,
  "rounding": 0,
  "margin": 62.10,
  "transacted_at": "2025-06-15 14:32:00",
  "claimed_at": "2025-06-15 14:33:00",
  "deliver_at": null,
  "receipt_ref": "659",
  "linked_receipt_ref": null,
  "receipt_email": "jane@example.com",
  "receipt_is_email": true,
  "type": "sale",
  "status": "completed",
  "order_id": null,
  "order_number": null,
  "order": null,
  "external_order_id": null,
  "item_skus": ["SKU-001", "SKU-002"],
  "need_action": false,
  "redemption_id": null,
  "redemption": null,
  "tags": [{ "id": 12, "handle": "vip" }],
  "systems": [{ "id": 1, "handle": "pos" }],
  "custom_fields": { "pos": { "register": "3" } },
  "payments": [{ "type": "card", "amount": 149.95 }],
  "fees": [],
  "meta": {},
  "items": [
    { "id": "item-uuid", "name": "Silk Scarf", "quantity": 1, "sku": "SKU-001", "price_sell": 79.95, "price_original": 99.95, "is_return": false }
  ],
  "currency_values": [],
  "is_claimed": false,
  "profile": {
    "id": "profile-uuid",
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "jane@example.com",
    "tier_handle": "gold",
    "flattened_tags": ["vip"],
    "point_balance": 1500,
    "reward_balance": 25.00,
    "aggregations": { "spend_12m": 2450.00, "shop_count": 14 }
  },
  "created_at": "2025-06-15 14:32:00",
  "updated_at": "2025-06-15 14:33:00"
}

The nested profile on a transaction is a lighter summary than the standalone profile context: it omits custom_attributes, special_hours, and similar profile-only detail, but keeps identity, tier, balances, and aggregations.

Transaction item

Sent with transaction-item.created and transaction-item.sync. The item includes trimmed profile and transaction summaries and the resolved product, so a handler has the item in full context without extra calls.

{
  "id": "item-uuid",
  "profile_id": "profile-uuid",
  "profile": {
    "email": "jane@example.com",
    "flattened_statuses": ["active"],
    "tier": {
      "handle": "gold",
      "name": "Gold",
      "anniversary_at": "2025-01-15 00:00:00",
      "current_tier_value_min": 1000,
      "progress": { "current_remain": 250, "next_remain": 1550, "next_tier_handle": "platinum", "current_progress": 61 }
    },
    "region": { "id": 1, "handle": "au", "name": "Australia", "is_active": true }
  },
  "transaction_id": "txn-uuid",
  "transaction": {
    "meta": {},
    "currency": "AUD",
    "location": { "id": 2, "name": "Bondi", "type": "store" },
    "transacted_at": "2025-06-15 14:32:00",
    "timezone": "Australia/Sydney"
  },
  "is_void": false,
  "is_transaction_void": false,
  "name": "Silk Scarf",
  "quantity": 1,
  "quantity_abs": 1,
  "price_current": 79.95,
  "price_sell": 79.95,
  "price_sell_abs": 79.95,
  "price_original": 99.95,
  "price_margin": 33.10,
  "price_tax": 7.27,
  "is_return": false,
  "product_variant_id": "variant-uuid",
  "product_id": "product-uuid",
  "item_sku": "SKU-001",
  "variant_external_id": "SHOP-VAR-001",
  "sku": "SKU-001",
  "barcode": "9312345678900",
  "product_variant_description": "Silk Scarf, Blue",
  "product_variant_meta": {},
  "product": {
    "title": "Silk Scarf",
    "brand": "Acme",
    "department": "Accessories",
    "type": "apparel",
    "external_id": "SHOP-PROD-88",
    "flattened_tags": ["new-season"]
  },
  "product_options": [{ "name": "Colour", "value": "Blue", "sort_order": 1 }],
  "product_images": [
    { "url": "https://cdn.example.com/scarf.jpg", "mime_type": "image/jpeg", "width": 800, "height": 800, "sort_order": 1 }
  ],
  "discounts": [],
  "discount_reasons": [],
  "custom_fields": {},
  "department": "Accessories",
  "meta": {},
  "order_id": null,
  "list_items": [],
  "created_at": "2025-06-15 14:32:00",
  "updated_at": "2025-06-15 14:32:00"
}

The nested profile and transaction here are fixed summaries specific to this context, not the full profile or transaction context.

Order

Sent with order.created and order.updated. An Order is the mutable pre-purchase record that becomes zero or more Transactions on finalisation, so the context can carry both its items and any resulting transactions.

{
  "id": "order-uuid",
  "external_id": "WEB-55021",
  "redemption_id": null,
  "redemption": null,
  "profile_id": "profile-uuid",
  "staff_id": null,
  "staff": null,
  "profile": {
    "id": "profile-uuid",
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "jane@example.com",
    "tier_handle": "gold",
    "flattened_tags": ["vip"],
    "point_balance": 1500,
    "aggregations": { "spend_12m": 2450.00, "shop_count": 14 }
  },
  "location_id": 2,
  "location": { "id": 2, "name": "Bondi", "type": "store" },
  "currency_id": 1,
  "currency": "AUD",
  "total": 149.95,
  "is_void": false,
  "total_original": 199.95,
  "currency_rate": 1,
  "rounding": 0,
  "margin": 62.10,
  "meta": {},
  "deliver_at": null,
  "claimed_at": null,
  "transacted_at": "2025-06-15 14:32:00",
  "tags": [],
  "systems": [{ "id": 3, "handle": "shopify" }],
  "items": [
    {
      "id": "oi-uuid",
      "profile_id": "profile-uuid",
      "order_id": "order-uuid",
      "name": "Silk Scarf",
      "quantity": 1,
      "price_sell": 79.95,
      "price_original": 99.95,
      "sku": "SKU-001",
      "barcode": "9312345678900",
      "product": { "brand": "Acme", "department": "Accessories", "description": "Silk Scarf, Blue" }
    }
  ],
  "transactions": [],
  "custom_fields": {},
  "payments": [],
  "receipt_is_email": false,
  "receipt_ref": null,
  "receipt_email": null,
  "type": "web",
  "status": "open",
  "order_number": "WEB-55021",
  "due_date": "2025-06-20 00:00:00",
  "fees": [],
  "created_at": "2025-06-15 14:32:00",
  "updated_at": "2025-06-15 14:32:00"
}

profile and staff are the full profile context. Each items entry is the full order item context, and each transactions entry is the full transaction context.

Reward

Sent with reward.created, reward.updated, and reward.extended. A Reward is a dollar-value discount with an expiry, so the instance and its definition both appear.

{
  "id": "reward-uuid",
  "profile_id": "profile-uuid",
  "profile": {
    "id": "profile-uuid",
    "first_name": "Jane",
    "email": "jane@example.com",
    "tier_handle": "gold",
    "aggregations": { "spend_12m": 2450.00, "shop_count": 14 }
  },
  "value_initial": 20.00,
  "value_remaining": 20.00,
  "expires_at": "2025-09-01 00:00:00",
  "issued_at": "2025-06-01 00:00:00",
  "is_expired": false,
  "is_active": true,
  "timezone": "Australia/Sydney",
  "notify_issue_at": "2025-06-01 00:00:00",
  "notify_expiry_at": "2025-08-25 00:00:00",
  "issued_local_at": "2025-06-01 10:00:00",
  "expires_local_at": "2025-09-01 10:00:00",
  "extended_at": null,
  "definition_id": "rdef-uuid",
  "definition_handle": "birthday-reward",
  "meta": {},
  "definition": { "id": "rdef-uuid", "handle": "birthday-reward", "name": "Birthday Reward", "type": "fixed", "value": 20.00 },
  "source_id": "txn-item-uuid",
  "source_type": "transaction_item",
  "source": {
    "id": "txn-item-uuid",
    "quantity": 1,
    "quantity_abs": 1,
    "price_current": 79.95,
    "price_sell": 79.95,
    "price_sell_abs": 79.95,
    "price_original": 99.95,
    "price_margin": 33.10,
    "item_sku": "SKU-001"
  },
  "created_at": "2025-06-01 00:00:00",
  "updated_at": "2025-06-01 00:00:00"
}

profile is the full profile context and definition is the full reward definition context. source describes what earned the reward: its shape depends on source_type (transaction_item, transaction, or reward), and it is null when the reward has no source.

Benefit

Sent with benefit.created and benefit.updated. A Benefit is a non-monetary incentive such as a discount voucher, event RSVP, or free product.

{
  "id": "benefit-uuid",
  "external_id": null,
  "profile_id": "profile-uuid",
  "definition": { "id": "bdef-uuid", "handle": "free-coffee", "name": "Free Coffee", "type": "product" },
  "profile": {
    "id": "profile-uuid",
    "first_name": "Jane",
    "email": "jane@example.com",
    "tier_handle": "gold"
  },
  "expires_at": "2025-07-01 00:00:00",
  "issued_at": "2025-06-01 00:00:00",
  "is_expired": false,
  "is_redeemable": true,
  "redemptions_remaining": 1,
  "has_redemptions": false,
  "redemption_items": [
    { "id": "ri-uuid", "count": 1, "value": 0, "created_at": "2025-06-10 09:00:00", "updated_at": "2025-06-10 09:00:00" }
  ],
  "definition_id": "bdef-uuid",
  "definition_handle": "free-coffee",
  "meta": {},
  "redeem_code_pos": "FREECOFFEE",
  "redeem_code_online": "FREECOFFEE",
  "combine_meta": null,
  "timezone": "Australia/Sydney",
  "value": null,
  "claimed_at": null,
  "created_at": "2025-06-01 00:00:00",
  "updated_at": "2025-06-01 00:00:00",
  "extended_at": null,
  "source_id": null,
  "source_type": null,
  "source": null
}

definition is the full benefit definition context and profile is the full profile context. source follows the same pattern as rewards.

Credit

Sent with credit.created, credit.updated, credit.extended, and credit.released. Credits are store-issued value with a balance and expiry.

{
  "id": "credit-uuid",
  "profile_id": "profile-uuid",
  "profile": { "id": "profile-uuid", "first_name": "Jane", "email": "jane@example.com", "tier_handle": "gold" },
  "creator_profile_id": null,
  "creator_profile": null,
  "staff_id": null,
  "location_id": 2,
  "name": "Store Credit",
  "credit_definition_id": "cdef-uuid",
  "timezone": "Australia/Sydney",
  "recipient_first_name": null,
  "recipient_email": null,
  "message": null,
  "value_initial": 50.00,
  "value_remaining": 50.00,
  "issued_at": "2025-06-01 00:00:00",
  "expires_at": "2026-06-01 00:00:00",
  "released_at": null,
  "extended_at": null,
  "external_id": null,
  "external_namespace": null,
  "credit_number": "GC-100045",
  "security_code": "A1B2C3",
  "source_id": null,
  "source_type": null,
  "locked": false,
  "lock_expires_at": null,
  "has_notified_issue": true,
  "has_notified_expiry": false,
  "has_notified_release": false,
  "has_notified_remind": false,
  "has_notified_extend": false,
  "meta": {},
  "is_imported": false,
  "is_system_generated": false,
  "definition": { "id": "cdef-uuid", "handle": "store-credit", "name": "Store Credit", "type": "fixed" },
  "created_at": "2025-06-01 00:00:00",
  "updated_at": "2025-06-01 00:00:00",
  "source": null
}

profile, creator_profile, and definition are the full profile and credit definition contexts. source follows the same pattern as rewards.

Tier

Sent with tier.achieved, tier.maintained, and tier-point.created. A Tier is a status level, so the context pairs the profile with the tier definition and current progress.

{
  "id": "tier-uuid",
  "profile_id": "profile-uuid",
  "achieved_at": "2025-06-15 14:35:00",
  "anniversary_at": "2026-06-15 00:00:00",
  "maintained_at": null,
  "assigned_at": null,
  "is_recalculated": false,
  "definition": {
    "id": "tdef-uuid",
    "handle": "gold",
    "name": "Gold",
    "value_min": 1000,
    "value_maintain": 800,
    "is_floor": false
  },
  "progress": {
    "current_remain": 250,
    "next_remain": 1550,
    "next_tier_handle": "platinum",
    "current_progress": 61
  },
  "profile": { "id": "profile-uuid", "first_name": "Jane", "email": "jane@example.com", "tier_handle": "gold" },
  "created_at": "2023-01-15 00:00:00",
  "updated_at": "2025-06-15 14:35:00"
}

The profile shown here is the full profile context (see Profile). The related tier events carry a different shape: tier.switched sends new and old tier definitions, and tier.lost sends the profile, the new tier, and the lost definition.

Rating

Sent with rating.created and rating.updated. When the rating is linked to a transaction, the full transaction is included; otherwise transaction is null.

{
  "id": "rating-uuid",
  "profile_id": "profile-uuid",
  "source": "pos",
  "score_type": "star",
  "score": 5,
  "product_id": "product-uuid",
  "product_variant_id": "variant-uuid",
  "transaction_id": "txn-uuid",
  "transaction": {
    "id": "txn-uuid",
    "profile_id": "profile-uuid",
    "total": 149.95,
    "transacted_at": "2025-06-15 14:32:00",
    "external_id": "ORDER-10334"
  },
  "interaction_id": null,
  "staff_id": null,
  "external_id": null,
  "status": "published",
  "namespace": null,
  "title": "Lovely scarf",
  "comment": "Great quality and fast delivery.",
  "reason": null,
  "is_public": true,
  "is_active": true,
  "requires_action": false,
  "meta": {},
  "profile": {
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "jane@example.com",
    "identities": []
  },
  "created_at": "2025-06-16 09:00:00",
  "updated_at": "2025-06-16 09:00:00"
}

The transaction object is the full transaction context; the fields above are a representative subset. The profile here is a fixed summary of name, email, and identities.

Supporting objects

Some fields nest smaller context objects that recur across events:

Object	Where it appears	Key fields
`identity`	Profiles, ratings, deletions	`handle`, `identifier`, `is_primary`, `is_active`
`address`	Profiles, orders	`address_line_1`, `city`, `postcode`, `country`, `is_default`, `custom_fields`
`location`	Transactions, orders, profiles	`id`, `name`, `type`, `timezone`, `external_id`, `external_code`
`tag`	Profiles, transactions, products	`id`, `handle`
`aggregations`	Profiles	`spend_12m`, `spend_all`, `spend_atv_12m`, `shop_count`, `shop_days`
`definition`	Rewards, benefits, credits, tiers	The matching Definition object for the instance

Using contexts in reactions

All fields in a context are available as variables in reaction filters and target templates. For profile events the fields sit at the root (tier_handle, aggregations.spend_12m). For events with a nested profile, such as transactions, the paths are prefixed (profile.tier_handle). See JSON Conditions for the reference syntax.

Context versus API response

If you need data the context does not include, such as a full transaction history, make a follow-up API call using the id or profile_id from the context. Deleted events carry identifiers precisely so you can reconcile against your own copy without a lookup.

Core setup

Profiles and data

Commerce

Incentives

Reactions

Webhooks and events

Frontend & SDK

POS integration

Appointments

Lists

Groups

Feedback

Extensions

Why contexts differ from API responses

How a context is built

The `requested_by` object

Event reference

Profiles and identity

Transactions and orders

Incentives

Tiers and achievements

Lists, products, ratings, and interactions

Appointments

Groups and connections

Configuration and reference data

Detailed payloads

Profile

Transaction

Transaction item

Order

Reward

Benefit

Credit

Tier

Rating

Supporting objects

Using contexts in reactions

Context versus API response

​Why contexts differ from API responses

​How a context is built

​The requested_by object

​Event reference

​Profiles and identity

​Transactions and orders

​Incentives

​Tiers and achievements

​Lists, products, ratings, and interactions

​Appointments

​Groups and connections

​Configuration and reference data

​Detailed payloads

​Profile

​Transaction

​Transaction item

​Order

​Reward

​Benefit

​Credit

​Tier

​Rating

​Supporting objects

​Using contexts in reactions

​Context versus API response

Why contexts differ from API responses

How a context is built

The `requested_by` object

Event reference

Profiles and identity

Transactions and orders

Incentives

Tiers and achievements

Lists, products, ratings, and interactions

Appointments

Groups and connections

Configuration and reference data

Detailed payloads

Profile

Transaction

Transaction item

Order

Reward

Benefit

Credit

Tier

Rating

Supporting objects

Using contexts in reactions

Context versus API response