Event reference

Webhook subscriptions and platform event functions choose from the same event types. Copy names exactly as written here: a misspelt custom event saves without complaint and never fires.

How to read the event tables

Each family table has a Webhooks and a Functions column. Each cell says what that subscription picker offers and whether the event arrives:

Functions add their own trigger rules: see How platform events are delivered.

A delivered request

Here, Lindenhall's CRM receives a reward.won.v1 event. The headers are explained in About webhooks.

POST /omnilab/events HTTP/1.1
Host: crm.lindenhall.example
Content-Type: application/json
User-Agent: OmniLab-Webhook/1.0
webhook-id: msg_6abe2823c1e5b2a9d4f81c3e:callbacks/3bb6d5ca-a587-4a81-84e0-7e200394b9c5
webhook-timestamp: 1790847012
webhook-signature: v1,LXEWQrcmsEQBYnyp+6wy9chTD7GQPMTbAiWHF5IaSIE=

The body is a CloudEvents document: the event's identity at the top, its details in data. It is formatted here for reading. The real body is one line of compact JSON, and the signature covers those exact bytes.

{
  "specversion": "1.0",
  "id": "6abe2823c1e5b2a9d4f81c3e",
  "type": "reward.won.v1",
  "subject": "d96c390f-5753-441c-baa3-0689a8c83716",
  "time": "2026-10-01T09:30:11.482Z",
  "datacontenttype": "application/json",
  "tenantid": "tenants/1e3f8137-9ea4-4d99-a7be-023d88c4f8c1",
  "data": {
    "contact": {
      "contact_id": "contacts/922eb227-f65a-4998-b116-a53edaf0d325",
      "unique_visitor_id": "e1bcce15-7972-4afc-bd6d-871ca666b7d0",
      "external_contact_id": "LH-0042817"
    },
    "tenant_context": {
      "subdomain": "lindenhall"
    },
    "group_context": {
      "group_id": "groups/6946c01f-8542-471c-9e2f-dac2661027c6",
      "unique_key": "lindenhall-riverside"
    },
    "interaction": {
      "interaction_id": "interactions/6cc002c6-2be1-412c-ac0d-c5d16a8c7cc6",
      "interaction_display_name": "Autumn Prize Draw",
      "interaction_public_key": "autumn-prize-draw"
    },
    "web_context": {
      "utm": { "source": "instagram", "medium": "social" },
      "user_agent": {
        "os": "iOS",
        "device": "iPhone",
        "is_mobile": true,
        "is_desktop": false,
        "is_tablet": false,
        "is_bot": false
      }
    },
    "reward_id": "d96c390f-5753-441c-baa3-0689a8c83716",
    "internal_reward_id": "rewards/42101441-81cd-45c9-bca0-993039133359",
    "reward_display_name": "£10 food court voucher",
    "reward_winning_method": "FIRST_COME_FIRST_SERVE",
    "coupon_code_id": "coupons/3bb6d5ca-a587-4a81-84e0-7e200394b9c5",
    "coupon_code_value": "LH10-7QK2"
  }
}

A few top-level attributes that only identify the sender are left out above. Empty fields are often omitted. Read every field as optional, and ignore the ones you don't use.

A function receives the same type, id, time, source and data, without the headers: see PlatformEvent.

Fields most events share

Besides its own fields, data carries context blocks:

No block carries the contact's email or name. A function reads them with OmniLab.Contact.get(data.contact.contact_id).

How filters match

A webhook subscription filter compares one value in the event with the value you enter, exactly.

To receive one campaign only, filter in your receiver on data.interaction.interaction_public_key. Function subscriptions have their own filter keys: see Narrow a subscription with filters.

Touchpoint events

Reward events

Contact and other events

Both pickers list these under Contact and Other.

Booking, ticket and attendance events

The webhook picker lists these under Booking & Ticket and Participation.

In these events, event_id and event_name name the bookable activity, not the platform event.

{
  "booking_id": "2394d604-afcc-4f7f-98c1-ef3676c20d6b",
  "event_id": "8f1c2a47-3b9e-4d6a-9c05-71e2b4d8a913",
  "event_name": "VIP styling session",
  "tickets_number": 2,
  "reserver_id": "contacts/922eb227-f65a-4998-b116-a53edaf0d325",
  "host_id": "host_K7m2Qx9",
  "ticket_type_id": "ticket_5d0e9b3c-6f1a-4c2e-8a7d-2b9f4e6c1a08",
  "ticket_type_display_name": "VIP",
  "slot_start_date": "2026-05-03T14:00:00Z",
  "slot_end_date": "2026-05-03T14:30:00Z",
  "booked_at": "2026-04-26T09:15:00Z"
}

Receipt submission events

Smart Link events

It adds smart_link_id, slug, title, destination_url, redirection_status, variant_id, variant_name and variant_variables to data. It identifies the visitor, never a contact, so it can't trigger a function.

Event group types

The webhook picker's Event group lists six types the platform never sends. A subscription to them saves, but nothing arrives, so leave them out:

• event.created.v1, event.deleted.v1 and event.type.updated.v1
• event.availability.updated.v1, event.slot.reached_capacity.v1 and event.fully_booked.v1

Choosing events for analytics

Feeding a warehouse or a BI tool? Teams most often subscribe a webhook to these:

• touchpoint.page_visit.v1
• touchpoint.participated.v1
• touchpoint.completed.v1
• reward.won.v1
• reward.redeemed.v1
• smartlink.redirected.v1

Subscribe only to what the destination reads. A filtered subscription costs nothing, while an unwanted delivery still costs you a request.

Next steps

• Configure webhooks
• Platform event functions
• Function SDK reference