Customers Segment Create

Webhookcustomers/segment_create

Triggered when a C-end customer segment is created.

Requires the customer access scope. Minimum supported version: 202007.

Request headers

X-Shoplazza-Topicstring
The event that triggered this delivery, e.g. orders/create
Example: orders/create
X-Shoplazza-Hmac-Sha256string

Base64-encoded HMAC-SHA256 signature of the request body, generated with your app's Client Secret. Use it to verify the request comes from Shoplazza

X-Shoplazza-Shop-Domainstring
The domain of the store that generated the event
Example: example.myshoplaza.com
X-Shoplazza-Api-Versionstring
The API version used to serialize the payload
Example: 2025-06
X-Shoplazza-Deduplication-IDstring

Deduplication ID for this delivery. It stays the same across retries of the same event—use it for idempotency

Request body

Schema

• customer_segment object

  idstring

  Customer segment ID

  namestring

  Segment name

  filterstring

  Segment filter conditions (embedded JSON string)

  statestring

  Segment status (normal = active, invalid = inactive)

  source_namestring

  Data source (admin = admin panel, api = API)

  app_namestring

  Name of the app that created the segment

  created_atstring

  Time when the segment was created

  updated_atstring

  Time when the segment was last updated

Example

{
  "customer_segment": {
    "id": "string",
    "name": "string",
    "filter": "string",
    "state": "string",
    "source_name": "string",
    "app_name": "string",
    "created_at": "string",
    "updated_at": "string"
  }
}