Skip to main content

Retrieve Instance State

EVENT 
webhook

Provides the current state of a specific instance. This endpoint allows clients to query and ascertain the operational status of an instance, ensuring the system can react appropriately to its state.

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: [state.instance]

    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: [on, off, deleted]

Responses​

Successfully received the state of the instance. The server acknowledged the request and returned status 200 to indicate the successful retrieval of data.

Loading...