Events - Customer Segment

Overview

Webhook events related to the creation, update, and deletion of customer segments.

Available events

Event type
Event schema

customer-segment.customer-assignment-created

{
  "assignmentType": "String",
  "customer": {
    "email": "String",
    "firstName": "String",
    "id": "String",
    "lastName": "String"
  },
  "legalEntity": {
    "id": "String",
    "name": "String"
  },
  "metadata": {},
  "mixins": "Map",
  "segmentId": "String",
  "tenant": "String"
}

customer-segment.customer-assignment-deleted

{
  "customerId": "String",
  "legalEntityId": "String",
  "segmentId": "String",
  "tenant": "String"
}

customer-segment.customer-assignment-updated

{
  "assignmentType": "String",
  "customer": {
    "email": "String",
    "firstName": "String",
    "id": "String",
    "lastName": "String"
  },
  "legalEntity": {
    "id": "String",
    "name": "String"
  },
  "metadata": {},
  "mixins": "Map",
  "segmentId": "String",
  "tenant": "String"
}

customer-segment.item-assignment-created

{
  "item": {
    "code": "String",
    "id": "String",
    "name": {
        "name" : "Map"
    },
  }
  "metadata": {},
  "mixins": "Map",
  "segmentId": "String",
  "tenant": "String",
  "type": "String"
}

customer-segment.item-assignment-deleted

{
  "itemId": "String",
  "segmentId": "String",
  "tenant": "String",
  "type": "String"
}

customer-segment.item-assignment-updated

{
  "item": {
    "code": "String",
    "id": "String",
    "name": {
        "name" : "Map"
    },
  }
  "metadata": {},
  "mixins": "Map",
  "segmentId": "String",
  "tenant": "String",
  "type": "String"
}

customer-segment.segment-created

{
  "description": {},
  "id": "String",
  "metadata": {},
  "name": {
    "name" : "Map"
  },
  "siteCode": "String",
  "status": "String",
  "tenant": "String",
  "validity": {}
}

customer-segment.segment-deleted

{
  "id": "String",
  "tenant": "String"
}

customer-segment.segment-updated

{
  "description": {},
  "id": "String",
  "metadata": {},
  "mixins": "Map",
  "name": {
    "name" : "Map"
  },
  "previousStatus": "String",
  "siteCode": "String",
  "status": "String",
  "tenant": "String",
  "validity": {}
}

Last updated

Was this helpful?