Skip to content

Corpo do HTTP Request: referência completa ​

Esta página detalha o que a ação HTTP Request envia quando o modo do corpo é Dados do GetRaze. São 124 campos em nove blocos, campo a campo, com o tipo de cada um e as ressalvas que evitam surpresa do outro lado.

Para o passo a passo da ação — autenticação, headers, timeout, o que fazer se falhar — veja a seção HTTP Request da referência.


As quatro regras ​

RegraO que significa
Formato fixoO corpo é o mesmo para todo gatilho. O que muda é o bloco trigger e o que vem vazio — quem recebe não precisa de um tratamento por evento
Sem mensagemO histórico da conversa nunca sai. Do bloco conversation vão canal, status, responsável, setor, contagens, data e direção da última mensagem, a prévia dela e o resumo da IA
Ausente é nuloBloco sem dado vira null, nunca some. Lista vazia vira []. Um gatilho de contato, sem oportunidade, manda "opportunity": null
Desmarcar cortaBloco desmarcado na tela sai do JSON — a chave nem aparece. É diferente de vir nula, e serve para aliviar o corpo quando a API do outro lado não precisa de tudo

As cinco chaves fixas ​

Não têm caixa na tela e vão sempre, em qualquer modo:

ChaveO que é
eventSempre automation.run
sent_atQuando a requisição saiu, em ISO 8601
testtrue quando o envio partiu do botão Testar request, e não de uma rodada de verdade
automationid e name da automação
accountid e name da conta

💡 O test é o que permite ao outro lado ignorar os seus testes sem criar registro duplicado. Vale tratar logo na primeira integração.


O corpo completo ​

json
{
  "event": "automation.run",
  "sent_at": "2026-10-13T20:42:39.650Z",
  "test": false,
  "automation": { "id": "a3f1c8d2-…", "name": "Boas-vindas ao lead qualificado" },
  "account": { "id": "298ea01f-…", "name": "Empresa Exemplo" },
  "trigger": {
    "type": "stage_entered",
    "payload": {
      "pipeline_id": "05807b60-…",
      "pipeline_name": "Vendas",
      "stage_id": "fcb99a5a-…",
      "stage_name": "Qualificado",
      "from_stage_id": null,
      "label": "Vendas › Qualificado",
      "depth": 0
    }
  },
  "contact": {
    "id": "be295e44-…",
    "name": "Ana Exemplo",
    "first_name": "Ana",
    "last_name": "Exemplo",
    "email": "ana@exemplo.com.br",
    "phone": "+5511900000000",
    "company": "Exemplo Saúde",
    "title": "Diretora de Operações",
    "type": "lead",
    "source": "linkedin",
    "timezone": "America/Sao_Paulo",
    "owner": { "id": "2d19889d-…", "name": "Beto Exemplo", "email": "beto@empresaexemplo.com.br" },
    "sector": { "id": "2c41d458-…", "name": "Comercial" },
    "tags": [
      { "id": "14ad536a-…", "name": "Cliente", "color": "#b05efe" },
      { "id": "20e97cec-…", "name": "Quente", "color": "#dc2626" }
    ],
    "custom_fields": { "cnpj": "00.000.000/0001-00", "segmento": "Varejo" },
    "channels": [
      { "provider": "whatsapp", "identifier": "+5511900000000" },
      { "provider": "linkedin", "identifier": "ana-exemplo" }
    ],
    "last_interaction_at": "2026-10-13 18:42:05",
    "created_at": "2026-08-07 22:33:41",
    "url": "https://app.getraze.co/contacts/be295e44-…"
  },
  "company": {
    "id": "79c675f5-…",
    "name": "Exemplo Saúde",
    "domain": "exemplosaude.com.br",
    "website": "https://exemplosaude.com.br",
    "industry": "Operadora de plano de saúde",
    "size": "501-1000",
    "headquarters": "Campinas, São Paulo, Brasil",
    "locations": null,
    "icp_fit": 82,
    "tier": 3,
    "revenue_range": null
  },
  "opportunity": {
    "id": "6e7e688e-…",
    "title": "Implantação Atendimento IA",
    "value": 74500,
    "currency": "BRL",
    "probability": 40,
    "status": "open",
    "pipeline": { "id": "05807b60-…", "name": "Vendas" },
    "stage": { "id": "fcb99a5a-…", "name": "Qualificado", "is_win": false, "is_loss": false },
    "owner": { "id": "2d19889d-…", "name": "Beto Exemplo", "email": "beto@empresaexemplo.com.br" },
    "expected_close_date": "2026-10-28T03:00:00.000Z",
    "products": [
      { "id": "7bedaac8-…", "name": "Licença mensal", "quantity": 1, "price": 26500 },
      { "id": "8af067bf-…", "name": "Implantação", "quantity": 1, "price": 48000 }
    ],
    "tags": [ { "id": "14ad536a-…", "name": "Cliente", "color": "#b05efe" } ],
    "custom_fields": { "origem_campanha": "Google Ads" },
    "won_at": null,
    "lost_at": null,
    "loss_reason": null,
    "created_at": "2026-08-07 22:33:44",
    "url": "https://app.getraze.co/pipelines/05807b60-…?opp=6e7e688e-…"
  },
  "other_opportunities": [
    {
      "id": "ce246c25-…",
      "title": "Exemplo Saúde — Consultoria",
      "pipeline": "Serviços",
      "stage": "Identificação",
      "value": 4500,
      "currency": "BRL",
      "status": "open"
    }
  ],
  "conversation": {
    "id": "45e96d72-…",
    "channel": { "id": "1b9c3c00-…", "provider": "whatsapp", "name": "WhatsApp Comercial", "identifier": "+5511900000001" },
    "status": "manual",
    "ai_active": false,
    "manual_control_taken": true,
    "assigned_user": { "id": "2d19889d-…", "name": "Beto Exemplo", "email": "beto@empresaexemplo.com.br" },
    "sector": { "id": "2c41d458-…", "name": "Comercial" },
    "messages_count": 14,
    "unread_count": 0,
    "last_message_at": "2026-10-13 20:22:05",
    "last_message_direction": "inbound",
    "last_message_preview": "Pode me mandar a proposta?",
    "summary": "Interessada no plano; pediu proposta com desconto anual.",
    "campaign": null,
    "opened_at": "2026-10-08 14:10:41",
    "url": "https://app.getraze.co/inbox/45e96d72-…"
  },
  "tasks": {
    "open": 2,
    "overdue": 1,
    "next": { "id": "80f0a145-…", "title": "Enviar proposta", "due_at": "2026-10-14 20:00:00", "assignee": "Beto Exemplo" }
  },
  "roadmaps": [
    {
      "id": "8039b4ce-…",
      "name": "Onboarding comercial",
      "status": "in_progress",
      "progress": "3/8",
      "started_at": "2026-10-10 11:20:05"
    }
  ],
  "calendar": {
    "next_event": {
      "id": "2411a6b4-…",
      "title": "Demo Exemplo Saúde",
      "starts_at": "2026-10-16 17:00:00",
      "ends_at": "2026-10-16 18:00:00",
      "meet_url": "https://meet.google.com/abc-defg-hij"
    }
  }
}

Gatilho — trigger ​

O único bloco cujo formato muda. type é sempre o nome interno do gatilho; payload carrega o recorte daquele evento.

CampoTipoObservação
typestringstage_entered, opportunity_created, opportunity_won, opportunity_lost, opportunity_stalled, contact_created, tag_added, tag_removed, conversation_created, conversation_assigned, conversation_closed, conversation_reopened, ai_handoff
payload.pipeline_iduuidGatilhos de oportunidade. Vem com pipeline_name
payload.stage_iduuidGatilhos de etapa. Vem com stage_name
payload.from_stage_iduuid · nullEtapa de origem. null quando o card nasceu na etapa em vez de ser movido — é o que separa "criada" de "movida"
payload.tag_iduuidSó em tag_added e tag_removed
payload.channel_account_iduuidGatilhos de conversa
payload.sector_iduuidSó em conversation_assigned
payload.sourcestringSó em contact_created. A origem do contato
payload.daysnumberSó em opportunity_stalled. Vem com stalled_since
payload.labelstring · nullO rótulo legível da rodada, como aparece em Execuções
payload.depthnumberProfundidade de encadeamento. 0 quando o evento veio de uma pessoa ou do sistema

Contato — contact ​

A pessoa. null quando a rodada não tem contato — raro, porque quase todo gatilho parte de um.

CampoTipoObservação
iduuid
namestringNome completo, como foi cadastrado
first_namestring · nullSó quando veio separado na origem. Não é derivado de name
last_namestring · null
emailstring · null
phonestring · nullSempre E.164 com +
companystring · nullO texto digitado no contato. Para a empresa cadastrada, use o bloco company
titlestring · nullCargo
typestring · nulllead ou client
sourcestring · nulllinkedin, import, instagram_captura, whatsapp_qr…
timezonestring · nullIANA, ex. America/Sao_Paulo
ownerobjeto · nullResponsável: id, name, email
sectorobjeto · nullid, name
tagsarrayCada item: id, name, color. Em ordem alfabética
custom_fieldsobjetoA chave é o identificador do campo, não o rótulo da tela. {} quando não há nenhum
channelsarrayCada item: provider, identifier. Só os canais ativos
last_interaction_attimestamp · null
created_attimestamp
urlstringLink direto para o contato no GetRaze

Empresa — company ​

A empresa cadastrada, vinda do vínculo da oportunidade e, na falta dele, do contato. null quando o contato não está ligado a nenhuma.

CampoTipoObservação
iduuid
namestring
domainstring · null
websitestring · null
industrystring · array · nullQuando veio do enriquecimento, é um array de nomes em inglês. Quando foi digitado, é texto
sizestring · nullFaixa, ex. 501-1000
headquartersstring · nullVazio na maior parte da base
locationsobjeto · nullEstrutura livre vinda do enriquecimento
icp_fitnumber · null0 a 100. null significa "não avaliei", não "não cabe"
tiernumber · nullCamada de ABM
revenue_rangestring · nullVazio na maior parte da base

Oportunidade — opportunity ​

O negócio da rodada. null em gatilhos que não têm um — contato criado, etiqueta, conversa.

CampoTipoObservação
iduuid
titlestring
valuenumber · null
currencystringBRL quando não foi definida
probabilitynumber0 a 100
statusstringopen, won ou lost. É derivado de won_at e lost_at; não existe coluna de status no banco
pipelineobjeto · nullid, name
stageobjeto · nullid, name, is_win, is_loss
ownerobjeto · nullid, name, email
expected_close_datedate · null
productsarrayCada item: id, name, quantity, price. O preço é o unitário
tagsarrayEtiquetas da oportunidade, distintas das do contato
custom_fieldsobjeto
won_at / lost_attimestamp · null
loss_reasonstring · nullO nome do motivo, não o id
created_attimestamp
urlstringAbre o card no funil

Outras oportunidades — other_opportunities ​

Os demais negócios do mesmo contato, em qualquer funil, do mais novo para o mais antigo. Teto de 20. Versão reduzida de propósito: para o negócio completo existe o bloco acima.

CampoTipoObservação
iduuid
titlestring
pipelinestring · nullAqui é o nome, não um objeto
stagestring · nullIdem
valuenumber · null
currencystring
statusstringopen, won ou lost

Conversa (resumo) — conversation ​

A conversa da rodada ou, na falta dela, a última aberta do contato. null quando não há nenhuma aberta — o GetRaze nunca inventa uma.

CampoTipoObservação
iduuid
channelobjeto · nullid, provider, name, identifier. O provedor é o tipo de canal: whatsapp, instagram, linkedin, email…
statusstringai_active, manual ou closed
ai_activeboolean
manual_control_takenbooleantrue quando um humano assumiu. É o freio que impede a IA de voltar sozinha
assigned_userobjeto · nullQuem atende
sectorobjeto · null
messages_countnumber · null
unread_countnumber
last_message_attimestamp · null
last_message_directionstring · nullinbound ou outbound
last_message_previewstring · nullSó a última, truncada. É o mais perto de conteúdo que o corpo carrega
summarystring · nullResumo escrito pela IA, quando existe
campaignobjeto · nullA campanha que originou a conversa
opened_attimestamp
urlstringAbre a conversa no inbox

Tarefas — tasks ​

Contagem, não lista. Só as em aberto, da oportunidade ou, sem ela, do contato.

CampoTipoObservação
opennumberTeto de 50 na contagem
overduenumberDas abertas, quantas já venceram
nextobjeto · nullA de prazo mais próximo: id, title, due_at, assignee (o nome, não o id)

Playbooks — roadmaps ​

As execuções de playbook do negócio ou do contato, da mais nova para a mais antiga. Teto de 10.

⚠️ A chave do JSON é roadmaps, não playbooks. A tela foi renomeada; o corpo da requisição manteve o nome antigo para não quebrar quem já integrou.

CampoTipoObservação
iduuidId da execução, não do modelo
namestringNome do playbook no momento em que rodou
statusstringin_progress, completed ou cancelled
progressstringTexto no formato "3/8", não número
started_attimestamp

Calendário — calendar ​

Só a próxima reunião confirmada do contato ou da conversa. Compromisso passado ou cancelado não entra.

CampoTipoObservação
next_eventobjeto · nullnull quando não há nenhuma marcada
next_event.iduuid
next_event.titlestring
next_event.starts_at / ends_attimestamp
next_event.meet_urlstring · nullLink do Meet; na falta dele, o link do evento no Google Agenda

Escrever o meu ​

No modo Escrever o meu, você monta o JSON à mão no formato que a API do outro lado espera. O GetRaze substitui as variáveis e envia o resultado.

  • Onde vale: no corpo, na URL, nos headers e nos parâmetros da URL. As mesmas variáveis nos quatro;
  • Como substitui: sempre por texto. Valor ausente ou nulo vira string vazia, nunca a palavra null;
  • Se o JSON não for válido depois da substituição, o corpo é enviado como texto puro em vez de objeto. Vale conferir as aspas em volta de cada variável.

⚠️ São 11 variáveis, contra os 124 campos do corpo pronto. Quem precisa de empresa, etiquetas, produtos, campos personalizados ou dados da conversa não consegue montar isso à mão — para esses casos, o caminho é usar Dados do GetRaze e tratar o corpo do outro lado.

VariávelDe onde vemExemplo
{{contato.nome}}Nome completo do contatoAna Exemplo
{{contato.primeiro_nome}}Primeiro nome; na falta dele, a primeira palavra do nomeAna
{{contato.email}}E-mail do contatoana@exemplo.com.br
{{contato.telefone}}Telefone, E.164 com ++5511900000000
{{contato.empresa}}Campo "empresa" do contato, em textoExemplo Saúde
{{contato.cargo}}Cargo do contatoDiretora de Operações
{{oportunidade.titulo}}Título do negócio da rodadaImplantação Atendimento IA
{{oportunidade.valor}}Valor, sem símbolo nem separador de milhar74500
{{etapa.nome}}Etapa do gatilhoQualificado
{{pipeline.nome}}Funil do gatilhoVendas
{{usuario.nome}}Quem disparou, quando houve alguémBeto Exemplo
{{resposta.nome_do_campo}}Campo guardado da resposta de um HTTP Request anterior na mesma automação{{resposta.rd_uuid}}

Exemplo de corpo próprio ​

json
{
  "nome": "{{contato.nome}}",
  "email": "{{contato.email}}",
  "telefone": "{{contato.telefone}}",
  "empresa": "{{contato.empresa}}",
  "negocio": {
    "titulo": "{{oportunidade.titulo}}",
    "valor": "{{oportunidade.valor}}",
    "funil": "{{pipeline.nome}}",
    "etapa": "{{etapa.nome}}"
  },
  "origem": "getraze"
}

"valor" sai como texto, porque a substituição é textual. Para número, o outro lado converte — ou use Dados do GetRaze, onde opportunity.value já é numérico.


Próximos passos ​

GetRaze - AI-Powered Lead Generation