Webhooks

Entregas da outbox

Consulta a outbox de webhooks da instância e filtra por pendente, entregue ou falhou.

API key Escopo read

Exemplo de requisição

curl -X GET "https://seu-dominio/instances/:id/webhook-deliveries" \
  -H "x-api-key: $VERTICE_API_KEY"

const response = await fetch('https://seu-dominio/instances/:id/webhook-deliveries', {
  method: 'GET',
  headers: {
  'x-api-key': process.env.VERTICE_API_KEY ?? '',
  },
});

const payload = await response.json();
console.log(payload);

GET /instances/{id}/webhook-deliveries

API key

Entenda

Conceituação

Consulta a outbox de webhooks da instância e filtra por pendente, entregue ou falhou.

O corpo entregue é assinado com HMAC-SHA256 no header x-webhook-signature. Use o segredo retornado na criação da instância para validar o corpo cru.

Contrato

Atributos

3 campos

Header

x-api-key string obrigatório

API key do workspace (vtc_live_...). Também aceita Authorization: Bearer.

Path

id string obrigatório

ID da instância.

Query

status string opcional

Valores aceitos: pendente|entregue|falhou.

Contrato

Resposta

200

{
  "data": [
    {
      "id": "evt_...",
      "event": "message.received",
      "status": "entregue",
      "attempts": 1,
      "responseStatus": 200,
      "createdAt": "2026-10-26T18:00:00.000Z"
    }
  ]
}

Respostas de sucesso são envelopadas em data.

Erros comuns

400 Corpo, query ou parâmetro inválido. A resposta traz error.code e error.message.

401 Credencial ausente, inválida ou sessão expirada.

403 Escopo insuficiente, IP não autorizado ou workspace suspenso.

404 Recurso não encontrado ou pertence a outro workspace.