Huddle
Huddle Webhooks
Huddle
Huddle Webhooks
The Huddle component will emit webhook notifications when a user creates or joins a group huddle.
To read more about how to setup webhooks with our SDK, click here.
List of Action Types
| Action Type | Description |
|---|---|
created | When a User created a Huddle |
join | When a User joins a Huddle |
Processed vs Raw Formats
The Raw Format contains lot more metadata that might not be very useful for your notification processing.
In the Processed Format, we will automatically populate who should get what type of notification so that you dont have to write that logic. Eg: If someone was previously tagged on a comment, then they should receive an update notification vs if someone if tagged in this thread, then they should receive a notification that they were tagged in a comment. We recommend using this so that you dont have to maintain the logic on your end.
Processed format
| Field | Type | Required | Description |
|---|---|---|---|
from | UserObject | Yes | The user initiating the action |
projectName | string | Yes | Name of the project |
projectUrl | string | Yes | URL of the project |
actionType | string | Yes | Type of action: created or joined |
notificationSource | string | Yes | Source of notification: huddle |
documentId | string | Yes | ID of the document related to the action |
clientDocumentId | string | Yes | ID of the client document |
id | string | Yes | ID of the action |
timestamp | number | Yes | Timestamp of the action |
actionUser | UserObject | Yes | The user who performed the action |
Raw format
| Field | Type | Required | Description |
|---|---|---|---|
actionType | string | Yes | Type of action: created or joined |
notificationSource | string | Yes | Source of notification: huddle |
actionUser | UserObject | Yes | The user who performed the action |
metadata | object | Yes | Metadata related to the action |
platform | sdk | Yes | Platform where the action occurred |
Raw Format:
{
"actionType": "string", // created | joined
"notificationSource": "huddle",
"actionUser": {
// UserObject
},
"metadata": {
"apiKey": "string",
"clientDocumentId": "string",
"documentId": "string",
"pageInfo": {
"baseUrl": "string",
"path": "string",
"title": "string",
"url": "string"
}
},
"platform": "sdk"
}
Processed Format:
{
"from": {
// UserObject
},
"projectName": "string",
"projectUrl": "string",
"actionType": "string", // created | joined
"notificationSource": "huddle",
"documentId": "string",
"clientDocumentId": "string",
"id": "string",
"timestamp": 1234567890,
"actionUser": {
// UserObject
},
}