account.created

This event type is in the beta stage; specifications are subject to change at any time.

Event Body Fields

The request event body is a JSON object that contains the following fields:

type

string

account.created

data

Object

The object containing the event data.

Hide data

account

Account Object

The created account data.

Show account

string

The permanent ID of the account in ChatBrick.

storeId

string

ID of the account’s primary store. The value will be null if the account has no primary store configured (e.g., a brand manager’s account).

name

string

Name of the account.

This is for internal communication purposes; the name should never be displayed in a public customer-facing interface.Use displayName for referring to the account in a public interface.

displayName

string

Name of the account for referring in a public interface.

employeeId

string

The employee ID is configured by the account and is typically mapped to the employee ID in the brand’s HR system.

avatar

string

The URL of the account’s profile picture (avatar).

We don’t recommend embedding this image in any webpage because it’s not designed for that purpose.If you need to display this image on a webpage, please download it when you receive the event and serve it from your own server to ensure it works as expected.

timestamps

Object

Timestamps in ISO 8601 format.

Show timestamps

createdAt

string

The timestamp of when the account was created.

timestampsMs

Object

Timestamps are represented in numerical format; the number represents milliseconds elapsed since the epoch, which is defined as the midnight at the beginning of January 1, 1970, UTC.

Show timestampsMs

createdAt

string

The timestamp of when the account was created.

{
  "type": "account.created",
  "data": {
    "account": {
      "id": "clxvu9uj3000001ob92yrb61o",
      "storeId": "clxvu9l6l000001p27bdm9ydk",
      "name": "何沛妮",
      "displayName": "小何 | 台北101旗艦店",
      "employeeId": "50001",
      "avatar": "https://imagedelivery.net/zdm_0V2jGvo4F5LeqaPJDQ/5178a7f8-661f-46d7-d852-0b72a2242100/public"
    },
    "timestamps": {
      "createdAt": "2024-06-18T18:18:18.000Z"
    },
    "timestampsMs": {
      "createdAt": 1718734698000
    }
  }
}

Overview

Learn

Event Types

Event Body Fields

Overview

Learn

Event Types

Documentation Index

​Event Body Fields

Event Body Fields