RReveals/DocsGuia do produto e integraçõesConhecer o Reveals
SDK e APIAPI de eventos
DOCUMENTAÇÃO REVEALS

API de eventos

Contrato HTTP para criar, atualizar e mover um card no pipeline já existente.

Piloto local · use dados fictícios

Credencial vinculada ao pipeline

A tela Pixel do pipeline emite uma chave secreta vinculada à conta e ao pipeline. O backend do site a envia como Bearer. O navegador usa o script e fala apenas com o backend do próprio site.

Envie lead.upsert

O corpo leva orgId no contexto, pipelineId e stageId nos dados, externalId na identidade. O primeiro evento cria lead e negócio; eventos posteriores com o mesmo externalId atualizam o lead ou movem o negócio para o stageId enviado. Um movimento respeita as validações do pipeline e pode ser recusado se elas estiverem pendentes.

● ● ●Exemplo
POST /publico/api/eventos/v1
Authorization: Bearer ri_...
Content-Type: application/json

{ "version": 1, "eventId": "cadastro-<ID_REAL_DA_ACAO>", "type": "lead.upsert",
  "occurredAt": "2026-10-08T12:00:00.000Z",
  "subject": { "externalId": "<ID_REAL_DO_CLIENTE>" },
  "data": { "email": "ana@exemplo.com", "name": "Ana",
    "pipelineId": "<ID_DO_PIPELINE>", "stageId": "<ID_DA_ETAPA>" },
  "context": { "orgId": "<ID_DA_CONTA>" } }

Respostas e repetição

202 indica evento aplicado; 200 indica repetição idêntica. O mesmo eventId com outro corpo retorna 409. Chave de outro pipeline ou conta retorna 403; etapa inválida ou validação pendente retorna 422. O limite do corpo é 32 KB.

A rota antiga com alias e regras continua disponível para integrações anteriores; novos pipelines usam os IDs diretos documentados aqui.