Quando acontece?

Este evento é disparado quando um ou mais participantes são removidos de um grupo. A estrutura data fornece um panorama completo do contexto do evento, incluindo detalhes sobre o grupo afetado, o autor da ação, e os participantes demovidos.

Payload

{
  "created_at": "2024-03-24T15:07:13.353Z",
  "data": {
    "author": {
      "name": "Author Name",
      "id": "5511999999999",
      "profile_picture": "http://placeimg.com/640/480"
    },
    "group": {
      "description": null,
      "id": "123456789123456789",
      "invite_code": "HF7ApaBzds74lawPk80sw2",
      "is_announcement": false,
      "is_restricted": false,
      "name": "Group Name",
      "owner": {
        "name": "Group Owner Name",
        "id": "5511999999999",
        "profile_picture": "http://placeimg.com/640/480"
      },
      "profile_picture": "http://placeimg.com/640/480",
      "total_participants": 2
    },
    "participants": [
      {
        "name": "Participant 1",
        "id": "5511999999999",
        "profile_picture": "http://placeimg.com/640/480"
      }
    ]
  },
  "id": "nh5nkditkfoi3m44osybu",
  "type": "group.participants_removed"
}

Propriedades

PropriedadeDescrição
created_atData e hora da criação do evento, formatado em ISO 8601.
data.author.nameNome do autor da ação que desencadeou o evento.
data.author.idIdentificador único do autor da ação.
data.author.profile_pictureURL da foto de perfil do autor.
data.group.descriptionDescrição do grupo. null se não definido.
data.group.idIdentificador único do grupo afetado pelo evento.
data.group.invite_codeCódigo de convite do grupo, usado para adicionar novos membros. (null se a instância conectada não tiver permissão de obte-la)
data.group.is_announcementBooleano indicando se o grupo é de anúncios (true) ou não (false).
data.group.is_restrictedBooleano mostrando se o grupo é restrito para postagens de membros comuns (true) ou não (false).
data.group.nameNome do grupo afetado pelo evento.
data.group.owner.nameNome do proprietário do grupo.
data.group.owner.idIdentificador único do proprietário do grupo.
data.group.owner.profile_pictureURL da foto de perfil do proprietário do grupo.
data.group.profile_pictureURL da foto de perfil do grupo.
data.group.total_participantsNúmero total de participantes no grupo.
data.participants[].nameNome de cada participante demovido. (Este campo pode não estar presente ou aparecer como null)
data.participants[].idIdentificador único de cada participante que foi removido.
data.participants[].profile_pictureURL da foto de perfil de cada participante que foi removido.
idIdentificador único da notificação de webhook.
typeTipo do evento. Neste caso, group.participants_removed.