Webhooks
Reenfileirar entregas falhas
Recoloca entregas falhas ou pendentes na fila de envio.
API key
Escopo write
Exemplo de requisição
curl -X POST "https://seu-dominio/instances/:id/webhook-deliveries/retry" \
-H "x-api-key: $VERTICE_API_KEY" \
-H "content-type: application/json" \
-d '{"ids":[]}'
const response = await fetch('https://seu-dominio/instances/:id/webhook-deliveries/retry', {
method: 'POST',
headers: {
'x-api-key': process.env.VERTICE_API_KEY ?? '',
'content-type': 'application/json',
},
body: JSON.stringify({
"ids": []
}),
});
const payload = await response.json();
console.log(payload);
Entenda
Conceituação
Recoloca entregas falhas ou pendentes na fila de envio. Sem ids, reenfileira todas as falhas.
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.
Corpo JSON. Os campos abaixo são exemplos; campos marcados como obrigatórios precisam ser enviados.
Contrato
Atributos
Header
x-api-key
string
obrigatório
API key do workspace (vtc_live_...). Também aceita Authorization: Bearer.
content-type
string
obrigatório
application/json.
Path
id
string
obrigatório
ID da instância.
Body
ids
array
opcional
IDs das mensagens a marcar como lidas. Sem ids, usa as mais recentes do histórico.
Payload
Request Body
{
"ids": []
}
Contrato
200
Resposta
{
"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.