Customer Created/Modified

CRM Newsletter

The Customer event is triggered whenever a customer is created or modified. This event contains all relevant data about the customer, ensuring your application stays up-to-date with the latest changes in real time.

Info

In some cases, certain fields such as phone numbers and address may not be fully populated in the event payload. This is typically done to adhere to privacy and data protection regulations, or due to the specific scope of the application. For example in Newsletter use cases street and phone numbers are excluded.

JSON schema & example

Example payload

{
  "metadata": {
    "traceId": "19bebc7b-a2f6-4ca7-9b2e-912edc26d6d6",
    "occurredAt": "2024-12-11T14:42:55Z",
    "version": "1.0",
    "tenant": "1337",
    "type": "CUSTOMER"
  },
  "customerId": "rxrn:cx:14450:customer:624291d6e0591da94e503788",
  "customerNumber": "1234567",
  "companyName": "Beispiel GmbH",
  "salutation": "MR",
  "title": "Prof. Dr.",
  "firstName": "Max",
  "lastName": "Mustermann",
  "email": "max.mustermann@example.com",
  "telephoneNumbers": [
    {
      "type": "home",
      "number": "+49 171 1234567"
    },
    {
      "type": "mobile",
      "number": "+49 151 9876543"
    }
  ],
  "addresses": [
    {
      "addressType": "BILLING",
      "street": "Musterstraße 123",
      "city": "Musterstadt",
      "postalCode": "12345",
      "country": "DE",
      "additionalInfo": "Hinterhaus, 2. Stock"
    },
    {
      "addressType": "DELIVERY",
      "street": "Beispielweg 5",
      "city": "Beispielstadt",
      "postalCode": "67890",
      "country": "DE",
      "additionalInfo": "Erdgeschoss"
    }
  ],
  "advertisingConsent": {
    "emailConsent": true,
    "changeDateTime": "2023-10-31T18:00:00Z"
  },
  "customerGroups": [
    "VIP",
    "Stammkunde"
  ],
  "custom": {}
}

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Customer",
  "description": "Schema for a customer created or modified event",
  "type": "object",
  "required": [
    "metadata",
    "customerId",
    "customerNumber",
    "advertisingConsent"
  ],
  "properties": {
    "metadata": {
      "type": "object",
      "properties": {
        "traceId": {
          "type": "string",
          "format": "uuid",
          "description": "Unique identifier to trace the event."
        },
        "occurredAt": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp when the event occurred."
        },
        "version": {
          "type": "string",
          "pattern": "^[0-9]+\\.[0-9]+$",
          "description": "The version of the event schema, following semantic versioning."
        },
        "tenant": {
          "type": "string",
          "description": "Identifier of the tenant or organization associated with the event."
        },
        "type": {
          "type": "string",
          "enum": [
            "CUSTOMER",
            "CUSTOMER_DELETED",
            "EVENT",
            "EVENT_CAPACITY",
            "ORDER",
            "CANCELLATION",
            "CREDIT_NOTE",
            "RESERVATION",
            "RESERVATION_CANCELLATION",
            "PRICE_PROFILE",
            "PRICE_PROFILE_DELETED",
            "TICKET"
          ],
          "description": "Identifier of the tenant or organization associated with the event."
        }
      },
      "required": [
        "traceId",
        "occurredAt",
        "version",
        "tenant",
        "type"
      ],
      "additionalProperties": false
    },
    "customerId": {
      "type": "string",
      "description": "Unique identifier for the customer",
      "examples": [
        "624291d6e0591da94e503788"
      ]
    },
    "customerNumber": {
      "type": "string",
      "description": "Customer number",
      "examples": [
        "1234567"
      ]
    },
    "externalId": {
      "type": "string",
      "description": "External identifier for the customer",
      "examples": [
        "ABC123456"
      ]
    },
    "companyName": {
      "type": "string",
      "description": "Name of the company associated with the customer, if applicable",
      "examples": [
        "Beispiel GmbH"
      ]
    },
    "salutation": {
      "type": "string",
      "enum": [
        "MR",
        "MS"
      ],
      "description": "Customer's salutation, if applicable",
      "examples": [
        "MR"
      ]
    },
    "title": {
      "type": "string",
      "description": "Customer's title, such as 'PhD' or 'MD'",
      "examples": [
        "Prof. Dr."
      ]
    },
    "firstName": {
      "type": "string",
      "description": "Customer's first name",
      "examples": [
        "Max"
      ]
    },
    "lastName": {
      "type": "string",
      "description": "Customer's last name",
      "examples": [
        "Mustermann"
      ]
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Customer's email address",
      "examples": [
        "max.mustermann@example.com"
      ]
    },
    "telephoneNumbers": {
      "type": "array",
      "description": "List of customer's telephone numbers. Not available in newsletter scope.",
      "items": {
        "type": "object",
        "required": [
          "phoneType",
          "number"
        ],
        "properties": {
          "type": {
            "phoneType": "string",
            "enum": [
              "HOME",
              "WORK",
              "MOBILE",
              "OTHER"
            ],
            "description": "Type of phone number",
            "examples": [
              "HOME"
            ]
          },
          "number": {
            "type": "string",
            "description": "Phone number",
            "examples": [
              "+49 171 1234567"
            ]
          }
        }
      }
    },
    "addresses": {
      "type": "array",
      "description": "List of customer's addresses",
      "items": {
        "type": "object",
        "required": [
          "addressType",
          "city",
          "postalCode",
          "country"
        ],
        "properties": {
          "addressType": {
            "type": "string",
            "enum": [
              "BILLING",
              "DELIVERY",
              "OTHER"
            ],
            "description": "Type of address, such as billing or delivery",
            "examples": [
              "BILLING"
            ]
          },
          "street": {
            "type": "string",
            "description": "Street address. Not available in newsletter scope. ",
            "examples": [
              "Musterstraße 123"
            ]
          },
          "city": {
            "type": "string",
            "description": "City name",
            "examples": [
              "Musterstadt"
            ]
          },
          "postalCode": {
            "type": "string",
            "description": "Postal or ZIP code",
            "examples": [
              "12345"
            ]
          },
          "country": {
            "type": "string",
            "pattern": "^[A-Z]{2}$",
            "description": "ISO 3166-1 alpha-2 country code",
            "examples": [
              "DE"
            ]
          },
          "additionalInfo": {
            "type": "string",
            "description": "Additional address information such as apartment number or other instructions. Not available in newsletter scope.",
            "examples": [
              "Hinterhaus, 2. Stock"
            ]
          }
        }
      }
    },
    "advertisingConsent": {
      "type": "object",
      "description": "Object containing advertising consent information",
      "properties": {
        "emailConsent": {
          "type": "boolean",
          "description": "Indicates if the customer has consented to email advertising",
          "examples": [
            true
          ]
        },
        "changeDateTime": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time when advertising consent was last changed",
          "examples": [
            "2023-10-31T18:00:00Z"
          ]
        }
      }
    },
    "customerGroups": {
      "type": "array",
      "description": "List of groups the customer belongs to",
      "items": {
        "type": "string",
        "description": "Name of the customer group",
        "examples": [
          "VIP",
          "Stammkunde"
        ]
      }
    },
    "custom": {
      "type": "object",
      "description": "Custom data object"
    }
  }
}