ClientAddressAddedV1
v2.0.0

Holds information about when an address for a client is created
When firing this event make sure you set the `correlationId` in the headers. Our schemas have standard metadata make sure you read and follow it.

Details

This event can only be triggered once when a address is created in Operational data store.

Consumer / Producer Diagram

ClientAddressAddedV1 Schema (json)
{
  "$id": "https://example.com/ClientAddressAddedV1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ClientAddressAddedV1",
  "description": "An event raised when a address of client is added",
  "type": "object",
  "properties": {
    "metadata": {
      "type": "object",
      "properties": {
       
        "occurredAtUtc": {
          "type": "string",
          "description": "The date and time when 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 ClientAddressAddedV1"
        },
        "source": {
          "type": "string",
          "description": "The source of the event like was it genereated by Client using Web or WeChat"
        },
        "version": {
          "type": "string",
          "description": "Version number in format of V{n} for e.g V1, V2"
        },
        "sentAtUtc": {
          "type": "string",
          "description":  "When event was sent by the publishers in ISO 8601 "
        }         
      },
      "required": [ "occurredAtUtc", "typeName", "sentAtUtc", "version"]
    },
    "data": {
      "type": "object",
      "properties": {
       
      }
    }
  }
}
Edit this pageLast updated on 2026/1/30