contextual-comments

Before you start

To receive these events, you need to have a webhook event receiver preconfigured. You also need to understand the basic structure of the events accompanying the message object. If you haven't done this yet, please refer to the Webhooks section to learn how to do it.

Events

CREATE_MENTION

This event is triggered when a new mention is created.

Description of message object

The object message brings a list of recently created mentions. The list is composed of objects with the following properties:

Property	Type	Description
participantId	string	The ID of the participant who was mentioned.
commentsId	string	The ID of the comment where the mention was created.

Payload example

The following is an example of the payload sent when a mention is created:

{
    "id": "b0a811d7-9640-42ef-8ad3-e84187547076",
    "type": "CREATE_MENTION",
    "message": [
        {
            "participantId": "carlos",
            "commentsId": "79bf4ab9-6a8b-4e57-83db-6f728b6a544c"
        },
        {
            "participantId": "vinicius",
            "commentsId": "79bf4ab9-6a8b-4e57-83db-6f728b6a544c"
        }
    ]
}

DELETE_MENTION

This event is triggered when a mention is deleted.

Description of message object

The object message brings a list of recently deleted mentions. The list is composed of objects with the following properties:

Property	Type	Description
participantId	string	The ID of the participant who was mentioned.
commentsId	string	The ID of the comment where the mention was deleted.

Payload example

The following is an example of the payload sent when a mention is deleted:

{
    "id": "b0a811d7-9640-42ef-8ad3-e84187547076",
    "type": "DELETE_MENTION",
    "message": [
        {
            "participantId": "carlos",
            "commentsId": "79bf4ab9-6a8b-4e57-83db-6f728b6a544c"
        },
        {
            "participantId": "vinicius",
            "commentsId": "79bf4ab9-6a8b-4e57-83db-6f728b6a544c"
        }
    ]
}