diff --git a/fundamentals/webhooks-overview.mdx b/fundamentals/webhooks-overview.mdx index 1e1a2bfc5..3770dc2c7 100644 --- a/fundamentals/webhooks-overview.mdx +++ b/fundamentals/webhooks-overview.mdx @@ -77,7 +77,11 @@ To maximize reliability and avoid common issues, follow these recommendations: ## Webhook Event Triggers -CometChat supports webhook triggers for different categories of events. Click each event name to see its payload and details. +CometChat supports webhook triggers for different categories of events. Each event name links to its +payload in the [webhook API reference](/rest-api/management-apis/webhooks/overview#payload-structure-of-events). + +Five events have no payload documented yet, so their names are not links: `group_member_removed`, +`call_busy`, `call_cancelled`, `call_rejected` and `call_unanswered`. *** @@ -85,14 +89,14 @@ CometChat supports webhook triggers for different categories of events. Click ea | Event | Description | | ----------------------------------------------------------------------------------------- | ---------------------------------------------------- | -| [message\_sent](/fundamentals/webhooks#message_sent) | Triggered after a message is sent. | -| [message\_edited](/fundamentals/webhooks#message_edited) | Triggered after a message is edited. | -| [message\_deleted](/fundamentals/webhooks#message_deleted) | Triggered after a message is deleted. | -| [message\_delivery\_receipt](/fundamentals/webhooks#message_delivery_receipt) | Triggered when a message is delivered to the client. | -| [message\_read\_receipt](/fundamentals/webhooks#message_read_receipt) | Triggered when a message is marked as read. | -| [message\_reaction\_added](/fundamentals/webhooks#message_reaction_added) | Triggered when a user reacts to a message. | -| [message\_reaction\_removed](/fundamentals/webhooks#message_reaction_removed) | Triggered when a reaction is removed. | -| [user\_mentioned](/fundamentals/webhooks#user_mentioned) | Triggered when a user is mentioned in a message. | +| [message\_sent](/rest-api/management-apis/webhooks/overview#message_sent) | Triggered after a message is sent. | +| [message\_edited](/rest-api/management-apis/webhooks/overview#message_edited) | Triggered after a message is edited. | +| [message\_deleted](/rest-api/management-apis/webhooks/overview#message_deleted) | Triggered after a message is deleted. | +| [message\_delivery\_receipt](/rest-api/management-apis/webhooks/overview#message_delivery_receipt) | Triggered when a message is delivered to the client. | +| [message\_read\_receipt](/rest-api/management-apis/webhooks/overview#message_read_receipt) | Triggered when a message is marked as read. | +| [message\_reaction\_added](/rest-api/management-apis/webhooks/overview#message_reaction_added) | Triggered when a user reacts to a message. | +| [message\_reaction\_removed](/rest-api/management-apis/webhooks/overview#message_reaction_removed) | Triggered when a reaction is removed. | +| [user\_mentioned](/rest-api/management-apis/webhooks/overview#user_mentioned) | Triggered when a user is mentioned in a message. | *** @@ -100,9 +104,9 @@ CometChat supports webhook triggers for different categories of events. Click ea | Event | Description | | ------------------------------------------------------------------------------------------------------ | -------------------------------------------- | -| [user\_blocked](/fundamentals/webhooks#user_blocked) | Triggered when a user blocks another user. | -| [user\_unblocked](/fundamentals/webhooks#user_unblocked) | Triggered when a user unblocks another user. | -| [user\_connection\_status\_changed](/fundamentals/webhooks#user_connection_status_changed) | Triggered when a user connects/disconnects. | +| [user\_blocked](/rest-api/management-apis/webhooks/overview#user_blocked) | Triggered when a user blocks another user. | +| [user\_unblocked](/rest-api/management-apis/webhooks/overview#user_unblocked) | Triggered when a user unblocks another user. | +| [user\_connection\_status\_changed](/rest-api/management-apis/webhooks/overview#user_connection_status_changed) | Triggered when a user connects/disconnects. | *** @@ -110,18 +114,18 @@ CometChat supports webhook triggers for different categories of events. Click ea | Event | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------- | -| [group\_created](/fundamentals/webhooks#group_created) | Triggered after a group is created. | -| [group\_updated](/fundamentals/webhooks#group_updated) | Triggered after a group is updated. | -| [group\_deleted](/fundamentals/webhooks#group_deleted) | Triggered after a group is deleted. | -| [group\_member\_added](/fundamentals/webhooks#group_member_added) | Triggered when a member is added. | -| [group\_member\_removed](/fundamentals/webhooks#group_member_removed) | Triggered when a member is removed. | -| [group\_member\_banned](/fundamentals/webhooks#group_member_banned) | Triggered when a member is banned. | -| [group\_member\_unbanned](/fundamentals/webhooks#group_member_unbanned) | Triggered when a member is unbanned. | -| [group\_member\_joined](/fundamentals/webhooks#group_member_joined) | Triggered when a user joins a group. | -| [group\_member\_left](/fundamentals/webhooks#group_member_left) | Triggered when a user leaves a group. | -| [group\_member\_kicked](/fundamentals/webhooks#group_member_kicked) | Triggered when a member is kicked. | -| [group\_member\_scope\_changed](/fundamentals/webhooks#group_member_scope_changed) | Triggered when a member's scope changes. | -| [group\_owner\_transferred](/fundamentals/webhooks#group_owner_transferred) | Triggered when group ownership is transferred. | +| [group\_created](/rest-api/management-apis/webhooks/overview#group_created) | Triggered after a group is created. | +| [group\_updated](/rest-api/management-apis/webhooks/overview#group_updated) | Triggered after a group is updated. | +| [group\_deleted](/rest-api/management-apis/webhooks/overview#group_deleted) | Triggered after a group is deleted. | +| [group\_member\_added](/rest-api/management-apis/webhooks/overview#group_member_added) | Triggered when a member is added. | +| group\_member\_removed | Triggered when a member is removed. | +| [group\_member\_banned](/rest-api/management-apis/webhooks/overview#group_member_banned) | Triggered when a member is banned. | +| [group\_member\_unbanned](/rest-api/management-apis/webhooks/overview#group_member_unbanned) | Triggered when a member is unbanned. | +| [group\_member\_joined](/rest-api/management-apis/webhooks/overview#group_member_joined) | Triggered when a user joins a group. | +| [group\_member\_left](/rest-api/management-apis/webhooks/overview#group_member_left) | Triggered when a user leaves a group. | +| [group\_member\_kicked](/rest-api/management-apis/webhooks/overview#group_member_kicked) | Triggered when a member is kicked. | +| [group\_member\_scope\_changed](/rest-api/management-apis/webhooks/overview#group_member_scope_changed) | Triggered when a member's scope changes. | +| [group\_owner\_transferred](/rest-api/management-apis/webhooks/overview#group_owner_transferred) | Triggered when group ownership is transferred. | *** @@ -129,20 +133,20 @@ CometChat supports webhook triggers for different categories of events. Click ea | Event | Description | | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -| [call\_initiated](/fundamentals/webhooks#call_initiated) | Triggered when a call is initiated. | -| [call\_started](/fundamentals/webhooks#call_started) | Triggered when a call starts. | -| [call\_ended](/fundamentals/webhooks#call_ended) | Triggered when a call ends. | -| [call\_participant\_joined](/fundamentals/webhooks#call_participant_joined) | Triggered when a participant joins a call. | -| [call\_participant\_left](/fundamentals/webhooks#call_participant_left) | Triggered when a participant leaves a call. | -| [call\_busy](/fundamentals/webhooks#call_busy) | This hook is triggered when a 1-on-1 call cannot be connected because the recipient is already on another call (i.e., their line is busy). | -| [call\_cancelled](/fundamentals/webhooks#call_cancelled) | The hook triggers when the call is cancelled. | -| [call\_rejected](/fundamentals/webhooks#call_rejected) | This hook is triggered when a 1-on-1 call is explicitly rejected by the recipient. | -| [call\_unanswered](/fundamentals/webhooks#call_unanswered) | This hook is triggered when a call goes unanswered. | -| [meeting\_started](/fundamentals/webhooks#meeting_started) | Triggered when a meeting starts. | -| [meeting\_ended](/fundamentals/webhooks#meeting_ended) | Triggered when a meeting ends. | -| [meeting\_participant\_joined](/fundamentals/webhooks#meeting_participant_joined) | Triggered when a participant joins a meeting. | -| [meeting\_participant\_left](/fundamentals/webhooks#meeting_participant_left) | Triggered when a participant leaves a meeting. | -| [recording\_generated](/fundamentals/webhooks#recording_generated) | Triggered when a recording is generated. | +| [call\_initiated](/rest-api/management-apis/webhooks/overview#call_initiated) | Triggered when a call is initiated. | +| [call\_started](/rest-api/management-apis/webhooks/overview#call_started) | Triggered when a call starts. | +| [call\_ended](/rest-api/management-apis/webhooks/overview#call_ended) | Triggered when a call ends. | +| [call\_participant\_joined](/rest-api/management-apis/webhooks/overview#call_participant_joined) | Triggered when a participant joins a call. | +| [call\_participant\_left](/rest-api/management-apis/webhooks/overview#call_participant_left) | Triggered when a participant leaves a call. | +| call\_busy | This hook is triggered when a 1-on-1 call cannot be connected because the recipient is already on another call (i.e., their line is busy). | +| call\_cancelled | The hook triggers when the call is cancelled. | +| call\_rejected | This hook is triggered when a 1-on-1 call is explicitly rejected by the recipient. | +| call\_unanswered | This hook is triggered when a call goes unanswered. | +| [meeting\_started](/rest-api/management-apis/webhooks/overview#meeting_started) | Triggered when a meeting starts. | +| [meeting\_ended](/rest-api/management-apis/webhooks/overview#meeting_ended) | Triggered when a meeting ends. | +| [meeting\_participant\_joined](/rest-api/management-apis/webhooks/overview#meeting_participant_joined) | Triggered when a participant joins a meeting. | +| [meeting\_participant\_left](/rest-api/management-apis/webhooks/overview#meeting_participant_left) | Triggered when a participant leaves a meeting. | +| [recording\_generated](/rest-api/management-apis/webhooks/overview#recording_generated) | Triggered when a recording is generated. | *** @@ -150,9 +154,9 @@ CometChat supports webhook triggers for different categories of events. Click ea | Event | Description | | --------------------------------------------------------------------------------------------- | ------------------------------------------------------ | -| [moderation\_engine\_approved](/fundamentals/webhooks#moderation_engine_approved) | Triggered when a message is auto-approved. | -| [moderation\_engine\_blocked](/fundamentals/webhooks#moderation_engine_blocked) | Triggered when a message is auto-blocked. | -| [moderation\_manual\_approved](/fundamentals/webhooks#moderation_manual_approved) | Triggered when a blocked message is manually approved. | +| [moderation\_engine\_approved](/rest-api/management-apis/webhooks/overview#moderation_engine_approved) | Triggered when a message is auto-approved. | +| [moderation\_engine\_blocked](/rest-api/management-apis/webhooks/overview#moderation_engine_blocked) | Triggered when a message is auto-blocked. | +| [moderation\_manual\_approved](/rest-api/management-apis/webhooks/overview#moderation_manual_approved) | Triggered when a blocked message is manually approved. | *** @@ -160,16 +164,16 @@ CometChat supports webhook triggers for different categories of events. Click ea | Event | Description | | ----------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| [after\_campaign\_completed](/fundamentals/webhooks#after_campaign_completed) | Triggered when a campaign finishes sending to all targets. | -| [after\_campaign\_failed](/fundamentals/webhooks#after_campaign_failed) | Triggered when a campaign fails to deliver to its targets. | -| [after\_notification\_created](/fundamentals/webhooks#after_notification_created) | Triggered when a notification is created and begins dispatching. | -| [after\_feed\_item\_sent](/fundamentals/webhooks#after_feed_item_sent) | Triggered when an in-app feed item is sent to a user. | -| [after\_feed\_item\_delivered](/fundamentals/webhooks#after_feed_item_delivered) | Triggered when a feed item is delivered to the user's device. | -| [after\_feed\_item\_read](/fundamentals/webhooks#after_feed_item_read) | Triggered when a user reads a feed item. | -| [after\_feed\_item\_interacted](/fundamentals/webhooks#after_feed_item_interacted) | Triggered when a user interacts with a feed item. | -| [after\_push\_notification\_sent](/fundamentals/webhooks#after_push_notification_sent) | Triggered when a push notification is sent. | -| [after\_push\_notification\_delivered](/fundamentals/webhooks#after_push_notification_delivered) | Triggered when a push notification is delivered to the user's device. | -| [after\_push\_notification\_clicked](/fundamentals/webhooks#after_push_notification_clicked) | Triggered when a user clicks on a push notification. | +| [after\_campaign\_completed](/rest-api/management-apis/webhooks/overview#after_campaign_completed) | Triggered when a campaign finishes sending to all targets. | +| [after\_campaign\_failed](/rest-api/management-apis/webhooks/overview#after_campaign_failed) | Triggered when a campaign fails to deliver to its targets. | +| [after\_notification\_created](/rest-api/management-apis/webhooks/overview#after_notification_created) | Triggered when a notification is created and begins dispatching. | +| [after\_feed\_item\_sent](/rest-api/management-apis/webhooks/overview#after_feed_item_sent) | Triggered when an in-app feed item is sent to a user. | +| [after\_feed\_item\_delivered](/rest-api/management-apis/webhooks/overview#after_feed_item_delivered) | Triggered when a feed item is delivered to the user's device. | +| [after\_feed\_item\_read](/rest-api/management-apis/webhooks/overview#after_feed_item_read) | Triggered when a user reads a feed item. | +| [after\_feed\_item\_interacted](/rest-api/management-apis/webhooks/overview#after_feed_item_interacted) | Triggered when a user interacts with a feed item. | +| [after\_push\_notification\_sent](/rest-api/management-apis/webhooks/overview#after_push_notification_sent) | Triggered when a push notification is sent. | +| [after\_push\_notification\_delivered](/rest-api/management-apis/webhooks/overview#after_push_notification_delivered) | Triggered when a push notification is delivered to the user's device. | +| [after\_push\_notification\_clicked](/rest-api/management-apis/webhooks/overview#after_push_notification_clicked) | Triggered when a user clicks on a push notification. | *** diff --git a/rest-api/management-apis/webhooks/overview.mdx b/rest-api/management-apis/webhooks/overview.mdx index 79a34f8fc..212146481 100644 --- a/rest-api/management-apis/webhooks/overview.mdx +++ b/rest-api/management-apis/webhooks/overview.mdx @@ -101,6 +101,7 @@ Here is the list of properties associated with Webhook. #### Groups + ##### group\_created: @@ -139,6 +140,7 @@ Here is the list of properties associated with Webhook. + ##### group\_updated: @@ -168,6 +170,7 @@ Here is the list of properties associated with Webhook. + ##### group\_deleted: @@ -197,6 +200,7 @@ Here is the list of properties associated with Webhook. + ##### group\_owner\_transferred: @@ -227,6 +231,7 @@ Here is the list of properties associated with Webhook. + ##### group\_member\_added: @@ -273,6 +278,7 @@ Here is the list of properties associated with Webhook. + ##### group\_member\_banned: @@ -320,6 +326,7 @@ Here is the list of properties associated with Webhook. + ##### group\_member\_unbanned: @@ -367,6 +374,7 @@ Here is the list of properties associated with Webhook. + ##### group\_member\_joined: @@ -405,6 +413,7 @@ Here is the list of properties associated with Webhook. + ##### group\_member\_left: @@ -443,6 +452,7 @@ Here is the list of properties associated with Webhook. + ##### group\_member\_scope\_changed: @@ -492,6 +502,7 @@ Here is the list of properties associated with Webhook. + ##### group\_member\_kicked: @@ -542,6 +553,7 @@ Here is the list of properties associated with Webhook. #### Messages + ##### message\_sent: @@ -598,6 +610,7 @@ Here is the list of properties associated with Webhook. + ##### message\_edited: @@ -660,6 +673,7 @@ Here is the list of properties associated with Webhook. + ##### message\_deleted: @@ -709,6 +723,7 @@ Here is the list of properties associated with Webhook. + ##### message\_delivery\_receipt: @@ -741,6 +756,7 @@ Here is the list of properties associated with Webhook. + ##### message\_read\_receipt: @@ -773,6 +789,7 @@ Here is the list of properties associated with Webhook. + ##### message\_reaction\_added: @@ -801,6 +818,7 @@ Here is the list of properties associated with Webhook. + ##### message\_reaction\_removed: @@ -831,6 +849,7 @@ Here is the list of properties associated with Webhook. #### Users + ##### user\_connection\_status\_changed: @@ -862,6 +881,7 @@ Here is the list of properties associated with Webhook. + ##### user\_blocked: @@ -889,6 +909,7 @@ Here is the list of properties associated with Webhook. + ##### user\_unblocked: @@ -916,6 +937,7 @@ Here is the list of properties associated with Webhook. + ##### user\_mentioned: @@ -956,6 +978,7 @@ Here is the list of properties associated with Webhook. #### Calls & Meetings + ##### call\_initiated: @@ -987,6 +1010,7 @@ Here is the list of properties associated with Webhook. + ##### call\_started: @@ -1007,6 +1031,7 @@ Here is the list of properties associated with Webhook. + ##### call\_ended: @@ -1042,6 +1067,7 @@ Here is the list of properties associated with Webhook. + ##### call\_participant\_joined: @@ -1066,6 +1092,7 @@ Here is the list of properties associated with Webhook. + ##### call\_participant\_left: @@ -1091,6 +1118,7 @@ Here is the list of properties associated with Webhook. + ##### meeting\_started: @@ -1111,6 +1139,7 @@ Here is the list of properties associated with Webhook. + ##### meeting\_participant\_joined: @@ -1135,6 +1164,7 @@ Here is the list of properties associated with Webhook. + ##### meeting\_participant\_left: @@ -1160,6 +1190,7 @@ Here is the list of properties associated with Webhook. + ##### meeting\_ended: @@ -1189,6 +1220,7 @@ Here is the list of properties associated with Webhook. + ##### recording\_generated: @@ -1211,6 +1243,7 @@ Here is the list of properties associated with Webhook. + ##### transcription\_generated: @@ -1237,6 +1270,7 @@ Here is the list of properties associated with Webhook. #### Moderation + ##### moderation\_engine\_approved: @@ -1307,6 +1341,7 @@ Here is the list of properties associated with Webhook. + ##### moderation\_engine\_blocked: @@ -1377,6 +1412,7 @@ Here is the list of properties associated with Webhook. + ##### moderation\_manual\_approved: @@ -1490,6 +1526,7 @@ Here is the list of properties associated with Webhook. + ##### moderation\_engine\_failed: @@ -1560,6 +1597,7 @@ Here is the list of properties associated with Webhook. #### Campaigns + ##### after\_campaign\_completed: @@ -1592,6 +1630,7 @@ Here is the list of properties associated with Webhook. + ##### after\_campaign\_failed: @@ -1624,6 +1663,7 @@ Here is the list of properties associated with Webhook. + ##### after\_notification\_created: @@ -1658,6 +1698,7 @@ Here is the list of properties associated with Webhook. + ##### after\_feed\_item\_sent: @@ -1710,6 +1751,7 @@ Here is the list of properties associated with Webhook. + ##### after\_feed\_item\_delivered: @@ -1748,6 +1790,7 @@ Here is the list of properties associated with Webhook. + ##### after\_feed\_item\_read: @@ -1788,6 +1831,7 @@ Here is the list of properties associated with Webhook. + ##### after\_feed\_item\_interacted: @@ -1828,6 +1872,7 @@ Here is the list of properties associated with Webhook. + ##### after\_push\_notification\_sent: @@ -1869,6 +1914,7 @@ Here is the list of properties associated with Webhook. + ##### after\_push\_notification\_delivered: @@ -1909,6 +1955,7 @@ Here is the list of properties associated with Webhook. + ##### after\_push\_notification\_clicked: