Skip to main content

Update Notification for Group Participants

EVENT 
webhook

Sends notifications when changes are made to the participants of a WhatsApp group. This includes actions like adding, removing, promoting, or demoting members.

Request​

Header Parameters

    x-businessId stringrequired

    Identificador do negócio

    x-instanceId stringrequired

    Identificador da instanceia

    x-whatsappId stringrequired

    Identificador do whatsapp conectado

Body

    event string

    Possible values: [group.participants:update]

    instance object
    instanceId string
    name string
    state string

    Possible values: [active, inactive]

    connection string

    Possible values: [refused, close, open]

    createdAt date-time
    WhatsApp object
    whatsappId string
    remoteJid string
    pictureUrl string
    pushName string
    createdAt date-time
    Business object
    businessId string
    name string
    data object
    id string
    participants string[]
    action string

    Possible values: [add, remove, promote, demote]

Responses​

The API has successfully received the notification, returning a 200 status to confirm the successful reception.

Loading...