Overview
Event Types
- contact
- connection
- store
- account
contact.connection.connected
This event is triggered when a contact connects to a store or staff member.
{
"type": "contact.connection.connected",
"data": {
"contact": {
"id": "clrq5ca80000lb9c9dnxxfyid",
"name": "康宜恩",
"avatar": "https://uc.chatbrick.com/avatar/clrq5ca80000lb9c9dnxxfyid/avatar.jpeg"
},
"lineUsers": [
{
"id": "clxvsgpgi000001qgdxuka3vj",
"name": "Mr. Kang",
"lineUid": "U4d26836f2aadb5ad84cc8b5b729fc9a1",
"lineProviderId": "1660894172",
"profilePictureUrl": "https://profile.line-scdn.net/0m0450c48c7251b78e575b3a5bb3c4ea5a7e70d9d2d471"
}
],
"connectedStore": {
"id": "clxvu9l6l000001p27bdm9ydk",
"name": "台北101旗艦店",
"logo": "https://imagedelivery.net/zdm_0V2jGvo4F5LeqaPJDQ/5178a7f8-661f-46d7-d852-0b72a2242100/public",
"externalId": "10000"
},
"connectedStaff": {
"id": "clxvu9uj3000001ob92yrb61o",
"storeId": "clxvu9l6l000001p27bdm9ydk",
"name": "何沛妮",
"displayName": "小何 | 台北101旗艦店",
"employeeId": "50001",
"avatar": "https://imagedelivery.net/zdm_0V2jGvo4F5LeqaPJDQ/5178a7f8-661f-46d7-d852-0b72a2242100/public"
},
"timestamps": {
"connectedAt": "2024-06-08T18:18:18.888Z",
"initConnectedAt": "2024-06-08T18:18:18.888Z"
},
"timestampsMs": {
"connectedAt": 1717870698888,
"initConnectedAt": 1717870698888
}
}
}
Event Body Fields
The request event body is a JSON object that contains the following fields:
contact.connection.connected
The object containing the event data.
The URL of the contact’s avatar.
LINE users that belong to the contact. In most cases, there will be only one LINE user.
The name of the LINE user.
This is the name of the LINE user, it can be different from the contact name in some cases.
Learn more about it in LINE User ID documentation.
The LINE provider ID of the LINE user in. This value is sent as a string.
The URL of the LINE user’s profile picture.
This URL is provided by LINE and it may already be expired when you receive the event.
In most cases, you may want to use the avatar from the contact object instead.
In some rare cases, this field may be null if the contact is only connected to a staff member.
The permanent ID of the store in ChatBrick.
The URL of the store’s logo.
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.
The external ID is configured by the brand and is usually mapped to the brand’s internal system.
This field will be null if the contact is only connected to a store.
The permanent ID of the account in ChatBrick.
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 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.
Name of the account for referring in a public interface.
The employee ID is configured by the account and is typically mapped to the employee ID in the brand’s HR system.
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 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.
{
"type": "contact.connection.connected",
"data": {
"contact": {
"id": "clrq5ca80000lb9c9dnxxfyid",
"name": "康宜恩",
"avatar": "https://uc.chatbrick.com/avatar/clrq5ca80000lb9c9dnxxfyid/avatar.jpeg"
},
"lineUsers": [
{
"id": "clxvsgpgi000001qgdxuka3vj",
"name": "Mr. Kang",
"lineUid": "U4d26836f2aadb5ad84cc8b5b729fc9a1",
"lineProviderId": "1660894172",
"profilePictureUrl": "https://profile.line-scdn.net/0m0450c48c7251b78e575b3a5bb3c4ea5a7e70d9d2d471"
}
],
"connectedStore": {
"id": "clxvu9l6l000001p27bdm9ydk",
"name": "台北101旗艦店",
"logo": "https://imagedelivery.net/zdm_0V2jGvo4F5LeqaPJDQ/5178a7f8-661f-46d7-d852-0b72a2242100/public",
"externalId": "10000"
},
"connectedStaff": {
"id": "clxvu9uj3000001ob92yrb61o",
"storeId": "clxvu9l6l000001p27bdm9ydk",
"name": "何沛妮",
"displayName": "小何 | 台北101旗艦店",
"employeeId": "50001",
"avatar": "https://imagedelivery.net/zdm_0V2jGvo4F5LeqaPJDQ/5178a7f8-661f-46d7-d852-0b72a2242100/public"
},
"timestamps": {
"connectedAt": "2024-06-08T18:18:18.888Z",
"initConnectedAt": "2024-06-08T18:18:18.888Z"
},
"timestampsMs": {
"connectedAt": 1717870698888,
"initConnectedAt": 1717870698888
}
}
}