Skip to content

Commit 7c9b895

Browse files
presmihaylovDLeylandmattvagni
authored
add docs about chat_received webhook (#148)
* add docs about chat_received webhook * lint * Update _snippets/webhooks/thread-chat-received.mdx Co-authored-by: David Leyland <[email protected]> * Update api-reference/webhooks/thread-chat-received.mdx Co-authored-by: Mathias Vagni <[email protected]> --------- Co-authored-by: David Leyland <[email protected]> Co-authored-by: Mathias Vagni <[email protected]>
1 parent a1c776a commit 7c9b895

File tree

3 files changed

+117
-0
lines changed

3 files changed

+117
-0
lines changed

‎_snippets/webhooks/thread-chat-received.mdx

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
```json
2+
{
3+
"timestamp": "2023-11-02T15:32:28.831Z",
4+
"workspaceId": "w_01GST0W989ZNAW53X6XYHAY87P",
5+
"payload": {
6+
"eventType": "thread.chat_received",
7+
"chat": {
8+
"timelineEntryId": "t_01HE8AM6GZG6C3CM344HFDM3J3",
9+
"id": "ch_01HE8AM6GZPZ3Q3RBEVE5TZ80X",
10+
"customerReadAt": null,
11+
"attachments": [],
12+
"text": "You are welcome!",
13+
"createdAt": "2023-11-02T15:32:28.831Z",
14+
"createdBy": {
15+
"actorType": "customer",
16+
"userId": "c_01HDRC3CJHBWBAAF4K63Z11XZ5"
17+
},
18+
"updatedAt": "2023-11-02T15:32:28.831Z",
19+
"updatedBy": {
20+
"actorType": "customer",
21+
"userId": "c_01HDRC3CJHBWBAAF4K63Z11XZ5"
22+
}
23+
},
24+
"thread": {
25+
"id": "th_01HDRC3CRY6ESPZJ7FZCTRQWYH",
26+
"customer": {
27+
"id": "c_01HDRC3CJHBWBAAF4K63Z11XZ5",
28+
"email": {
29+
"email": "[email protected]",
30+
"isVerified": false,
31+
"verifiedAt": null
32+
},
33+
"externalId": null,
34+
"fullName": "Peter Santos",
35+
"shortName": "Peter",
36+
"markedAsSpamAt": null,
37+
"markedAsSpamBy": null,
38+
"customerGroupMemberships": [],
39+
"createdAt": "2023-10-27T10:50:24.209Z",
40+
"createdBy": {
41+
"actorType": "system",
42+
"system": "email_inbound_handler"
43+
},
44+
"updatedAt": "2023-11-02T08:57:32.944Z",
45+
"updatedBy": {
46+
"actorType": "user",
47+
"userId": "u_01H1V4NA10RMHWFBXB6A1ZBYRA"
48+
}
49+
},
50+
"title": "Unable to tail logs",
51+
"previewText": "Hey, I am currently unable to tail the logs of the service svc-8af1e3",
52+
"priority": 2,
53+
"externalId": null,
54+
"status": "TODO",
55+
"statusChangedAt": "2023-11-02T08:57:32.943Z",
56+
"statusChangedBy": {
57+
"actorType": "user",
58+
"userId": "u_01H1V4NA10RMHWFBXB6A1ZBYRA"
59+
},
60+
"statusDetail": null,
61+
"assignee": null,
62+
"assignedAt": null,
63+
"labels": [],
64+
"firstInboundMessageInfo": {
65+
"timestamp": "2023-10-27T10:50:24.323Z",
66+
"messageSource": "CHAT"
67+
},
68+
"firstOutboundMessageInfo": {
69+
"timestamp": "2023-10-27T10:50:52.944Z",
70+
"messageSource": "CHAT"
71+
},
72+
"lastInboundMessageInfo": {
73+
"timestamp": "2023-10-27T15:05:30.223Z",
74+
"messageSource": "CHAT"
75+
},
76+
"lastOutboundMessageInfo": {
77+
"timestamp": "2023-10-27T15:04:49.521Z",
78+
"messageSource": "CHAT"
79+
},
80+
"supportEmailAddresses": ["[email protected]"],
81+
"createdAt": "2023-10-27T10:50:24.323Z",
82+
"createdBy": {
83+
"actorType": "system",
84+
"system": "email_inbound_handler"
85+
},
86+
"updatedAt": "2023-11-02T08:57:32.943Z",
87+
"updatedBy": {
88+
"actorType": "user",
89+
"userId": "u_01H1V4NA10RMHWFBXB6A1ZBYRA"
90+
}
91+
}
92+
},
93+
"id": "pEv_01HE8AM6GZVS1S3609PFGR30FE",
94+
"webhookMetadata": {
95+
"webhookTargetId": "whTarget_01HD4400VTDJQ646V6RY37SR7K",
96+
"webhookTargetVersion": "2024-09-18",
97+
"webhookDeliveryAttemptId": "whAttempt_01HE8ANGEGVQVTCY3DD30CZ8G4",
98+
"webhookDeliveryAttemptNumber": 1,
99+
"webhookDeliveryAttemptTimestamp": "2023-11-02T15:33:11.760Z"
100+
},
101+
"type": "thread.chat_received"
102+
}
103+
```

‎api-reference/webhooks/thread-chat-received.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: 'Chat received'
3+
---
4+
5+
This event is fired when a chat message from a customer is received.
6+
7+
## Schema
8+
9+
[**View JSON Schema →**](https://core-api.uk.plain.com/webhooks/schema/latest.json)
10+
11+
Example:
12+
13+
<Snippet file="webhooks/thread-chat-received.mdx" />

‎mint.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,7 @@
271271
"api-reference/webhooks/thread-slack-message-received",
272272
"api-reference/webhooks/thread-slack-message-sent",
273273
"api-reference/webhooks/thread-chat-sent",
274+
"api-reference/webhooks/thread-chat-received",
274275
"api-reference/webhooks/thread-field-created",
275276
"api-reference/webhooks/thread-field-updated",
276277
"api-reference/webhooks/thread-field-deleted",

0 commit comments

Comments
 (0)