Customer Service events

Overview

Webhook events related to the creation, update and deletion of customer, sending a request to reset a customer's password and resending an account activation link to a customer.

Available events

Event typeEvent schema
customer.created
Copy
Copied
{
  "customerNumber": "String",
  "id": "String",
  "title": "String",
  "firstName": "String",
  "lastName": "String",
  "middleName": "String",
  "company": "String",
  "preferredSite": "String",
  "preferredCurrency": "String",
  "preferredLanguage": "String",
  "accounts": ["String"],
  "contactPhone": "String",
  "contactEmail": "String",
  "active": "Boolean",
  "onHold": "Boolean",
  "b2b": {
    "companyRegistrationId": "String"
  },
  "type": "String",
  "metadata": "Object",
  "mixins": "Map",
  "tenant": "String"
}
customer.updated
Copy
Copied
{
  "updatedBy": "String",
  "customerNumber": "String",
  "id": "String",
  "title": "String",
  "firstName": "String",
  "lastName": "String",
  "middleName": "String",
  "company": "String",
  "preferredSite": "String",
  "preferredCurrency": "String",
  "preferredLanguage": "String",
  "accounts": ["String"],
  "contactPhone": "String",
  "contactEmail": "String",
  "active": "Boolean",
  "onHold": "Boolean",
  "b2b": {
    "companyRegistrationId": "String"
  },
  "type": "String",
  "defaultAddress": "Object",
  "addresses": ["Object"],
  "metadata": "Object",
  "mixins": "Map",
  "tenant": "String"
}
customer.deleted
Copy
Copied
{
  "customerNumber": "String",
  "email": "String",
  "triggeredBy": "String",
  "tenant": "String"
}
customer.password-reset
Copy
Copied
{
  "email": "String",
  "token": "String"
}
customer.refresh-token
Copy
Copied
{
  "email": "String",
  "tenant": "String"
}
customer.opt-in
Copy
Copied
{
  "customerNumber": "String",
  "activateAccountUrl": "String",
  "token": "String"
}
customer.logged.in
Copy
Copied
{
  "tenant": "String",
  "sessionId": "String",
  "customerId": "String"
}