Skip to main content

Update Connection Status

EVENT 
webhook

Updates and informs about the current status of a given connection. This endpoint serves to both provide information on a connection's state and ensure synchronization between systems with respect to a connection's health and status.

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: [connection.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
    state string

    Possible values: [close, connecting, open]

    statusReason int32

Responses​

Successfully received the connection status update. The server acknowledged the information and returned status 200, indicating successful data reception.

Loading...