Webhooks

Disparar um evento de teste

Dispara um evento de teste assinado para validar URL, HMAC e recebimento.

API key Escopo write

Exemplo de requisição

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

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

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

POST /instances/{id}/webhook-test

API key

Entenda

Conceituação

Dispara um evento de teste assinado para validar URL, HMAC e recebimento.

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

2 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.

Contrato

Resposta

200

{
  "data": {
    "ok": true
  }
}

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.