{
  "anonymous_id":  "569a0e86-0484-4a84-afa8-cc55b76fe5c4",
  "locale":  "en-US",
  "message_id":  "07cf5c9f-fbb0-4877-bfad-e158d86978ee",
  "name":  "Product Details Page",
  "path":  "/products/123",
  "properties":  {
    "any":  "value",
    "you":  "can have"
  },
  "referrer":  "https://google.com",
  "search":  "?q=search+term",
  "timestamp":  "2024-03-20T15:30:00Z",
  "title":  "Product Details",
  "url":  "https://example.com/products/123",
  "user_agent":  "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)",
  "user_id":  "569a0e86-0484-4a84-afa8-cc55b76fe5c4"
}
{
  "anonymous_id":  "Anonymous identifier for the user",
  "locale":  "Locale of the page view",
  "message_id":  "Unique identifier for this message",
  "name":  "Name of the page",
  "path":  "Path portion of the URL",
  "properties":  "Page event properties, free-form dictionary of properties of the event",
  "referrer":  "URL of the previous page",
  "search":  "Query string portion of the URL",
  "timestamp":  "When this page view occurred",
  "title":  "Page title",
  "url":  "Full URL of the page",
  "user_agent":  "User agent string from the client",
  "user_id":  "Identifier for the page view (same as anonymous_id for Page events)"
}

Events

Triggering Webhook Types

The following event types are associated with the Page event payload from Customer Io.

  • Customer Io Page
{
  "anonymous_id":  "569a0e86-0484-4a84-afa8-cc55b76fe5c4",
  "locale":  "en-US",
  "message_id":  "07cf5c9f-fbb0-4877-bfad-e158d86978ee",
  "name":  "Product Details Page",
  "path":  "/products/123",
  "properties":  {
    "any":  "value",
    "you":  "can have"
  },
  "referrer":  "https://google.com",
  "search":  "?q=search+term",
  "timestamp":  "2024-03-20T15:30:00Z",
  "title":  "Product Details",
  "url":  "https://example.com/products/123",
  "user_agent":  "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)",
  "user_id":  "569a0e86-0484-4a84-afa8-cc55b76fe5c4"
}
{
  "anonymous_id":  "Anonymous identifier for the user",
  "locale":  "Locale of the page view",
  "message_id":  "Unique identifier for this message",
  "name":  "Name of the page",
  "path":  "Path portion of the URL",
  "properties":  "Page event properties, free-form dictionary of properties of the event",
  "referrer":  "URL of the previous page",
  "search":  "Query string portion of the URL",
  "timestamp":  "When this page view occurred",
  "title":  "Page title",
  "url":  "Full URL of the page",
  "user_agent":  "User agent string from the client",
  "user_id":  "Identifier for the page view (same as anonymous_id for Page events)"
}

Payload Field Details

Page
Event Payload
user_id
string
required

Identifier for the page view (same as anonymous_id for Page events)

CEL
user_id
Example
"569a0e86-0484-4a84-afa8-cc55b76fe5c4"
path
string
required

Path portion of the URL

CEL
path
Example
"/products/123"
referrer
string
required

URL of the previous page

CEL
referrer
Example
"https://google.com"

Query string portion of the URL

CEL
search
Example
"?q=search+term"
title
string
required

Page title

CEL
title
Example
"Product Details"
url
string
required

Full URL of the page

CEL
url
Example
"https://example.com/products/123"
user_agent
string
required

User agent string from the client

CEL
user_agent
Example
"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)"
locale
string
required

Locale of the page view

CEL
locale
Example
"en-US"
timestamp
timing.v1.Timestamp
required

When this page view occurred

CEL
timestamp
Example
"2024-03-20T15:30:00Z"
message_id
string
required

Unique identifier for this message

CEL
message_id
Example
"07cf5c9f-fbb0-4877-bfad-e158d86978ee"
properties
object
required

Page event properties, free-form dictionary of properties of the event

CEL
properties
Example
{
"any":  "value",
"you":  "can have"
}
anonymous_id
string
required

Anonymous identifier for the user

CEL
anonymous_id
Example
"569a0e86-0484-4a84-afa8-cc55b76fe5c4"
name
string
required

Name of the page

CEL
name
Example
"Product Details Page"