Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.flexype.io/llms.txt

Use this file to discover all available pages before exploring further.

The Collection Viewed Webhook is triggered when a customer views a specific collection page in your store. This data helps in understanding customer interests and can be used for personalized marketing and retargeting based on the collections they browse.

Headers

X-Flexype-Authorization
string
A secret key used to verify that the webhook request originated from FlexyPe. Ensure this token is validated to prevent unauthorized access.
X-Webhook-Version
string
The version of the webhook payload. Here, the value will be 2026-05.
X-Webhook-Id
string
The unique identifier of the webhook configured for your store.
X-Event-Id
string
The unique identifier for the event that triggered this webhook.

Body

event_time
string
The ISO 8601 timestamp when the event occurred.
event_type
string
The type of event. For this webhook, it is COLLECTION_VIEWED.
event_id
string
A unique identifier for the event.
store
object
Information about the store where the event occurred.
payload
object
The event-specific data.
{
  "event_time": "2026-05-07T10:00:00Z",
  "event_type": "COLLECTION_VIEWED",
  "event_id": "evt_987123654",
  "store": {
    "id": "store_01",
    "name": "My Awesome Store",
    "shopify_domain": "my-store.myshopify.com",
    "main_domain": "my-store.com"
  },
  "payload": {
    "user": {
      "email": "jane.doe@example.com",
      "full_name": "Jane Doe",
      "first_name": "Jane",
      "last_name": "Doe",
      "dial_code": "91",
      "phone": "9876543210",
      "phone_with_dial_code": "+919876543210"
    },
    "collection_viewed": {
      "collection_id": 112233,
      "name": "Summer Collection",
      "handle": "summer-collection",
      "image": "https://cdn.shopify.com/collections/summer.jpg",
      "timestamp": "2026-05-07T10:00:00Z"
    }
  }
}