ClientEmailUpdatedV1

v1.0.0

{
  "$id": "https://example.com/ClientEmailUpdatedV1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ClientEmailUpdatedV1",
  "description": "An event raised when a client updates their email address",
  "type": "object",
  "properties": {
    "metadata": {
      "type": "object",
      "properties": {
        "occurredAtUtc": {
          "type": "string",
          "description": "The date and time when the event occurred in UTC. Date should be represented in ISO 8601 format e.g., 2023-09-08T12:00:00Z"
        },
        "typeName": {
          "type": "string",
          "description": "The name of the event. E.g., ClientEmailUpdatedV1",
          "const": "ClientEmailUpdatedV1"
        },
        "source": {
          "type": "string",
          "description": "The source of the event indicating where the update was initiated (e.g., Web, Mobile App)"
        },
        "version": {
          "type": "number",
          "description": "The version of the event schema"
        },
        "sentAtUtc": {
          "type": "string",
          "description": "The date and time when the event was sent by the publisher in ISO 8601 format"
        }
      },
      "required": [ "occurredAtUtc", "typeName", "source", "version", "sentAtUtc" ]
    },
    "data": {
      "type": "object",
      "properties": {
        "clientId": {
          "type": "string",
          "description": "The GUID of the client"
        },
        "clientNumber": {
          "type": "number",
          "description": "The COS number of the client"
        },
        "clientUpdated": {
          "type": "object",
          "properties": {
            "emailAddress": {
              "type": "string",
              "description": "The updated email address"
            }
          },
          "required": [ "emailAddress" ]
        }
      },
      "required": [ "clientId", "clientUpdated" ]
    }
  },
  "required": [ "metadata", "data" ]
}