Receber eventos em tempo real (SSE)

GET /events

Abre uma conexão SSE (text/event-stream) que entrega os eventos da inbox em tempo real. Passo a passo, exemplos e limites: Eventos.

  • Cada evento sai como id: <id do evento> e data: <envelope>, com o mesmo envelope do webhook. Ao conectar chega o comentário : connected.
  • Saem os mesmos eventos do webhook, com os mesmos filtros (events e exclude, com os mesmos valores) e o mesmo payload. Sem events, chegam todos menos status_post.received, newsletter.updated, newsletter.message e history.batch, que só vêm pedidos pelo nome.
  • Sem reenvio: o que acontecer com a conexão fechada não volta; recupere pela busca (GET /messages). Leia rápido: se o leitor atrasar, a api descarta eventos dessa conexão.
  • Autentique com o header token. No navegador (o EventSource não manda header), ?token= também vale, mas o token fica no histórico e nos logs.

Autenticação

[
  {
    "token": []
  }
]

{
  "token": {
    "name": "token",
    "type": "apiKey",
    "in": "header"
  }
}

Parâmetros

[
  {
    "name": "events",
    "in": "query",
    "required": false,
    "schema": {
      "type": "string"
    },
    "description": "Eventos que você quer, separados por vírgula (ex.: `message.received,message.status`); o parâmetro também pode repetir. Sem ele, chegam todos, menos `status_post.received`, `newsletter.updated`, `newsletter.message` e `history.batch`, que só vêm pedidos pelo nome. Só os nomes de `OrkesioStreamEventType` (os mesmos do webhook): um nome fora da lista, ou do `/sse`, responde 400 e a conexão não abre."
  },
  {
    "name": "exclude",
    "in": "query",
    "required": false,
    "schema": {
      "type": "string"
    },
    "description": "Mensagens que **não** chegam nesta conexão, com os valores do `exclude` do webhook (vale para os eventos de mensagem, inclusive `message.status` e `group.receipts`, pela mensagem do recibo): `sent_by_api`, `not_sent_by_api`, `out` (as da inbox, inclusive pelo celular), `in` (as recebidas), `groups`, `not_groups`. Separados por vírgula (ex.: `sent_by_api,groups`); o parâmetro também pode repetir. Valor fora da lista, ou um valor com o oposto (`in` e `out`), responde 400."
  }
]

Respostas

{
  "200": {
    "description": "Stream de eventos. Cada `data:` é um `OrkesioEvent` (o mesmo envelope do webhook).",
    "content": {
      "text/event-stream": {
        "schema": {
          "type": "string"
        },
        "example": "id: evt_01JAB3K9ZQ7V0M4T8R2X6WYD5H\ndata: {\"id\":\"evt_01JAB3K9ZQ7V0M4T8R2X6WYD5H\",\"type\":\"message.received\",\"created_at\":\"2026-10-17T12:00:00.000Z\",\"inbox\":{\"id\":\"r0269625d29bfbd\",\"owner\":\"5511888888888\",\"channel\":\"whatsapp_web\"},\"data\":{\"message\":{\"id\":\"3EB0A1\",\"chat_id\":\"5511999999999@s.whatsapp.net\",\"author\":{\"id\":\"5511999999999@s.whatsapp.net\",\"phone\":\"5511999999999\"},\"direction\":\"in\",\"sent_at\":\"2026-10-17T12:00:00.000Z\",\"type\":\"text\",\"text\":\"oi\"},\"chat\":{\"id\":\"5511999999999@s.whatsapp.net\",\"type\":\"direct\"}}}\n\n"
      }
    }
  },
  "400": {
    "description": "Evento que o `/events` não tem, valor de `exclude` fora da lista (`invalid_request`), ou `excludeMessages`, que só vale no `/sse`.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "invalid_request",
          "message": "evento messages não existe no /events (só os nomes da Orkesio, como message.received)."
        }
      }
    }
  },
  "401": {
    "description": "Token inválido ou ausente.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "unauthorized",
          "message": "Token inválido."
        }
      }
    }
  },
  "429": {
    "$ref": "#/components/responses/RateLimited"
  },
  "500": {
    "$ref": "#/components/responses/InternalError"
  }
}

Estado: Disponível

Compatibilidade de canais

CanalCompatívelObservação
WhatsApp (Web)Sim
WhatsApp (API oficial)Sim
InstagramSim
MessengerSim
TelegramSim

Eventos que esta rota gera

Esta rota é o próprio canal de eventos: entrega, em tempo real, os mesmos eventos do webhook.

Antes e depois (uazapi → Orkesio)

Na uazapi: GET /sse.

  • Endpoint próprio (/events); o /sse continua igual.
  • Eventos com nome recurso.ação e o envelope do webhook (id, type, created_at, inbox, data). Antes, o payload de cada evento tinha formato próprio.
  • Sem excludeMessages: o filtro é pelo nome do evento.

#/components/schemas/OrkesioError

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Código estável do erro, em inglês e `snake_case`. Os de uso geral: `invalid_request` (400): pedido inválido: JSON malformado, campo desconhecido ou valor fora do permitido (o detalhe em `message`; o campo em `field`, quando é um só); `unauthorized` (401): `token` ou `admintoken` ausente ou inválido; `forbidden` (403): o token não pode fazer isso (no servidor de demonstração, por exemplo); `not_admin` (403): o WhatsApp recusou por falta de permissão no grupo ou na newsletter; `account_restricted` (403): o WhatsApp restringiu a conta de iniciar conversas novas (mandar para quem já conversa continua valendo; até quando, em `GET /inbox/limits`); `new_chat_limit` (403): a conta atingiu a cota do WhatsApp de conversas novas neste ciclo (veja `GET /inbox/limits`); os dois também no `error` de `OrkesioMessage` e de `message.status`, e não adianta repetir o envio; `payment_required` (403): na API oficial, a Meta recusou o envio por um problema no pagamento da conta do WhatsApp Business (erro 131042 da Meta); acerte a forma de pagamento no gerenciador da Meta, porque repetir não adianta; também no `error` de `OrkesioMessage` e de `message.status`; `whatsapp_rejected` (400): o WhatsApp recusou a mudança pedida (o campo, em `field`, quando é um só); `not_found` (404): o recurso não existe nesta inbox; `conflict` (409): o recurso já existe ou mudou (id em uso, inbox de outro canal); `inbox_not_paired` (409): a inbox ainda não conectou um número; `payload_too_large` (413): o corpo passou do limite; `canceled` e `expired`: só no `error` de `OrkesioMessage` e de `message.status` (envio cancelado antes de sair, ou que passou do prazo na fila); `rate_limited` (429): muitos pedidos; espere o `Retry-After`; `internal_error` (500): falha inesperada na api; tente de novo; `send_failed` (500): o envio falhou (o motivo em `message`); também no `error` de `OrkesioMessage` e de `message.status`; `unsupported_for_channel` (501): o canal da inbox não atende esta rota ou este tipo de mensagem; `meta_error` (502): a Meta recusou ou não respondeu; `disconnected` (503): a inbox está desconectada (sem sessão do WhatsApp, ou token do canal oficial vencido); `unavailable` (503 ou 504): o WhatsApp não respondeu a tempo, ou algo em andamento impede agora; tente de novo. Cada rota lista os códigos próprios dela (`outside_window`, `number_invalid`, `flow_invalid`...). A lista pode crescer: trate código desconhecido pelo status HTTP."
    },
    "message": {
      "type": "string",
      "description": "Descrição para pessoas (às vezes o texto do WhatsApp ou da Meta). Não compare o texto: use `error`."
    },
    "field": {
      "type": "string",
      "description": "O campo do pedido que causou o erro, quando é um só (por exemplo, o campo que o WhatsApp recusou num `PATCH`)."
    }
  },
  "required": [
    "error",
    "message"
  ],
  "additionalProperties": true,
  "description": "O objeto de erro da Orkesio, o mesmo em todo lugar: o corpo das respostas de erro e o `error` de `OrkesioMessage`, `message.status` e `message.failed`. Algumas rotas juntam campos próprios (`request_id`, `errors`...)."
}

#/components/responses/RateLimited

{
  "description": "`rate_limited`: passou do limite de chamadas desta inbox (ou do admin); espere o tempo do header `Retry-After` e tente de novo.",
  "headers": {
    "Retry-After": {
      "description": "Segundos até poder chamar de novo.",
      "schema": {
        "type": "integer",
        "minimum": 1
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OrkesioError"
      },
      "example": {
        "error": "rate_limited",
        "message": "Muitas requisições."
      }
    }
  }
}

#/components/responses/InternalError

{
  "description": "`internal_error`: falha inesperada na api (no banco, por exemplo); tente de novo.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OrkesioError"
      },
      "example": {
        "error": "internal_error",
        "message": "Falha inesperada."
      }
    }
  }
}

Guias relacionados

Visão geral · O que funciona em cada canal · O que muda da uazapi