Skip to content

HTTP Request body: full reference ​

This page details what the HTTP Request action sends when the body mode is GetRaze data. It is 124 fields across nine blocks, field by field, with each one's type and the caveats that prevent surprises on the other end.

For the action's step by step — authentication, headers, timeout, what to do on failure — see the HTTP Request section of the reference.


The four rules ​

RuleWhat it means
Fixed shapeThe body is the same for every trigger. What changes is the trigger block and what comes in empty — the receiving end does not need per-event handling
No messagesThe conversation history never goes out. From the conversation block you get channel, status, owner, sector, counts, the date and direction of the last message, its preview and the AI summary
Absent is nullA block with no data becomes null, it never disappears. An empty list becomes []. A contact trigger, with no opportunity, sends "opportunity": null
Unticking cutsA block unticked on screen leaves the JSON — the key does not even appear. That is different from coming in null, and it serves to slim the body down when the other end does not need everything

The five fixed keys ​

They have no checkbox on screen and are always sent, in any mode:

KeyWhat it is
eventAlways automation.run
sent_atWhen the request left, in ISO 8601
testtrue when the send came from the Test request button, and not from a real run
automationThe automation's id and name
accountThe account's id and name

💡 test is what lets the other end ignore your tests without creating duplicate records. Worth handling on the very first integration.


The complete body ​

json
{
  "event": "automation.run",
  "sent_at": "2026-10-13T20:42:39.650Z",
  "test": false,
  "automation": { "id": "a3f1c8d2-…", "name": "Welcome qualified lead" },
  "account": { "id": "298ea01f-…", "name": "Example Company" },
  "trigger": {
    "type": "stage_entered",
    "payload": {
      "pipeline_id": "05807b60-…",
      "pipeline_name": "Sales",
      "stage_id": "fcb99a5a-…",
      "stage_name": "Qualified",
      "from_stage_id": null,
      "label": "Sales › Qualified",
      "depth": 0
    }
  },
  "contact": {
    "id": "be295e44-…",
    "name": "Ana Example",
    "first_name": "Ana",
    "last_name": "Example",
    "email": "ana@example.com",
    "phone": "+5511900000000",
    "company": "Example Health",
    "title": "Head of Operations",
    "type": "lead",
    "source": "linkedin",
    "timezone": "America/Sao_Paulo",
    "owner": { "id": "2d19889d-…", "name": "Beto Example", "email": "beto@examplecompany.com" },
    "sector": { "id": "2c41d458-…", "name": "Sales" },
    "tags": [
      { "id": "14ad536a-…", "name": "Customer", "color": "#b05efe" },
      { "id": "20e97cec-…", "name": "Hot", "color": "#dc2626" }
    ],
    "custom_fields": { "tax_id": "00.000.000/0001-00", "segment": "Retail" },
    "channels": [
      { "provider": "whatsapp", "identifier": "+5511900000000" },
      { "provider": "linkedin", "identifier": "ana-example" }
    ],
    "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": "Example Health",
    "domain": "examplehealth.com",
    "website": "https://examplehealth.com",
    "industry": "Health insurance provider",
    "size": "501-1000",
    "headquarters": "Campinas, São Paulo, Brazil",
    "locations": null,
    "icp_fit": 82,
    "tier": 3,
    "revenue_range": null
  },
  "opportunity": {
    "id": "6e7e688e-…",
    "title": "AI Support rollout",
    "value": 74500,
    "currency": "BRL",
    "probability": 40,
    "status": "open",
    "pipeline": { "id": "05807b60-…", "name": "Sales" },
    "stage": { "id": "fcb99a5a-…", "name": "Qualified", "is_win": false, "is_loss": false },
    "owner": { "id": "2d19889d-…", "name": "Beto Example", "email": "beto@examplecompany.com" },
    "expected_close_date": "2026-10-28T03:00:00.000Z",
    "products": [
      { "id": "7bedaac8-…", "name": "Monthly license", "quantity": 1, "price": 26500 },
      { "id": "8af067bf-…", "name": "Rollout", "quantity": 1, "price": 48000 }
    ],
    "tags": [ { "id": "14ad536a-…", "name": "Customer", "color": "#b05efe" } ],
    "custom_fields": { "campaign_source": "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": "Example Health — Consulting",
      "pipeline": "Services",
      "stage": "Discovery",
      "value": 4500,
      "currency": "BRL",
      "status": "open"
    }
  ],
  "conversation": {
    "id": "45e96d72-…",
    "channel": { "id": "1b9c3c00-…", "provider": "whatsapp", "name": "Sales WhatsApp", "identifier": "+5511900000001" },
    "status": "manual",
    "ai_active": false,
    "manual_control_taken": true,
    "assigned_user": { "id": "2d19889d-…", "name": "Beto Example", "email": "beto@examplecompany.com" },
    "sector": { "id": "2c41d458-…", "name": "Sales" },
    "messages_count": 14,
    "unread_count": 0,
    "last_message_at": "2026-10-13 20:22:05",
    "last_message_direction": "inbound",
    "last_message_preview": "Can you send me the proposal?",
    "summary": "Interested in the plan; asked for a proposal with an annual discount.",
    "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": "Send proposal", "due_at": "2026-10-14 20:00:00", "assignee": "Beto Example" }
  },
  "roadmaps": [
    {
      "id": "8039b4ce-…",
      "name": "Sales onboarding",
      "status": "in_progress",
      "progress": "3/8",
      "started_at": "2026-10-10 11:20:05"
    }
  ],
  "calendar": {
    "next_event": {
      "id": "2411a6b4-…",
      "title": "Example Health demo",
      "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"
    }
  }
}

Trigger — trigger ​

The only block whose shape changes. type is always the trigger's internal name; payload carries that event's slice.

FieldTypeNote
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_iduuidOpportunity triggers. Comes with pipeline_name
payload.stage_iduuidStage triggers. Comes with stage_name
payload.from_stage_iduuid · nullSource stage. null when the card was born in the stage instead of being moved — that is what separates "created" from "moved"
payload.tag_iduuidOnly on tag_added and tag_removed
payload.channel_account_iduuidConversation triggers
payload.sector_iduuidOnly on conversation_assigned
payload.sourcestringOnly on contact_created. The contact's source
payload.daysnumberOnly on opportunity_stalled. Comes with stalled_since
payload.labelstring · nullThe run's readable label, as it appears under Runs
payload.depthnumberChaining depth. 0 when the event came from a person or from the system

Contact — contact ​

The person. null when the run has no contact — rare, because almost every trigger starts from one.

FieldTypeNote
iduuid
namestringFull name, as it was registered
first_namestring · nullOnly when it came in separately from the source. It is not derived from name
last_namestring · null
emailstring · null
phonestring · nullAlways E.164 with +
companystring · nullThe text typed on the contact. For the registered company, use the company block
titlestring · nullJob title
typestring · nulllead or client
sourcestring · nulllinkedin, import, instagram_captura, whatsapp_qr…
timezonestring · nullIANA, e.g. America/Sao_Paulo
ownerobject · nullOwner: id, name, email
sectorobject · nullid, name
tagsarrayEach item: id, name, color. In alphabetical order
custom_fieldsobjectThe key is the field's identifier, not its on-screen label. {} when there are none
channelsarrayEach item: provider, identifier. Active channels only
last_interaction_attimestamp · null
created_attimestamp
urlstringDirect link to the contact in GetRaze

Company — company ​

The registered company, coming from the opportunity's link and, failing that, from the contact. null when the contact is not tied to any.

FieldTypeNote
iduuid
namestring
domainstring · null
websitestring · null
industrystring · array · nullWhen it came from enrichment, it is an array of names in English. When it was typed, it is text
sizestring · nullRange, e.g. 501-1000
headquartersstring · nullEmpty across most of the base
locationsobject · nullFree-form structure coming from enrichment
icp_fitnumber · null0 to 100. null means "not evaluated", not "does not fit"
tiernumber · nullABM tier
revenue_rangestring · nullEmpty across most of the base

Opportunity — opportunity ​

The run's deal. null on triggers that have none — contact created, tag, conversation.

FieldTypeNote
iduuid
titlestring
valuenumber · null
currencystringBRL when it was not defined
probabilitynumber0 to 100
statusstringopen, won or lost. It is derived from won_at and lost_at; there is no status column in the database
pipelineobject · nullid, name
stageobject · nullid, name, is_win, is_loss
ownerobject · nullid, name, email
expected_close_datedate · null
productsarrayEach item: id, name, quantity, price. The price is the unit price
tagsarrayThe opportunity's tags, distinct from the contact's
custom_fieldsobject
won_at / lost_attimestamp · null
loss_reasonstring · nullThe reason's name, not its id
created_attimestamp
urlstringOpens the card in the funnel

Other opportunities — other_opportunities ​

The contact's remaining deals, in any funnel, newest to oldest. Capped at 20. A reduced version on purpose: for the complete deal there is the block above.

FieldTypeNote
iduuid
titlestring
pipelinestring · nullHere it is the name, not an object
stagestring · nullSame
valuenumber · null
currencystring
statusstringopen, won or lost

Conversation (summary) — conversation ​

The run's conversation or, failing that, the contact's last open one. null when there is no open one — GetRaze never invents one.

FieldTypeNote
iduuid
channelobject · nullid, provider, name, identifier. The provider is the channel type: whatsapp, instagram, linkedin, email…
statusstringai_active, manual or closed
ai_activeboolean
manual_control_takenbooleantrue when a human took over. It is the brake that keeps the AI from coming back on its own
assigned_userobject · nullWho is handling it
sectorobject · null
messages_countnumber · null
unread_countnumber
last_message_attimestamp · null
last_message_directionstring · nullinbound or outbound
last_message_previewstring · nullOnly the last one, truncated. It is the closest to content the body carries
summarystring · nullSummary written by the AI, when one exists
campaignobject · nullThe campaign that started the conversation
opened_attimestamp
urlstringOpens the conversation in the inbox

Tasks — tasks ​

A count, not a list. Only the open ones, from the opportunity or, without it, from the contact.

FieldTypeNote
opennumberCounting is capped at 50
overduenumberOf the open ones, how many are already past due
nextobject · nullThe one due soonest: id, title, due_at, assignee (the name, not the id)

Playbooks — roadmaps ​

The deal's or contact's playbook runs, newest to oldest. Capped at 10.

⚠️ The JSON key is roadmaps, not playbooks. The screen was renamed; the request body kept the old name so it would not break anyone who had already integrated.

FieldTypeNote
iduuidThe run's id, not the template's
namestringThe playbook's name at the moment it ran
statusstringin_progress, completed or cancelled
progressstringText in the "3/8" format, not a number
started_attimestamp

Calendar — calendar ​

Only the contact's or conversation's next confirmed meeting. Past or cancelled events do not come in.

FieldTypeNote
next_eventobject · nullnull when none is scheduled
next_event.iduuid
next_event.titlestring
next_event.starts_at / ends_attimestamp
next_event.meet_urlstring · nullThe Meet link; failing that, the event's link on Google Calendar

Write my own ​

In Write my own mode, you build the JSON by hand in the shape the other end's API expects. GetRaze replaces the variables and sends the result.

  • Where it applies: in the body, in the URL, in the headers and in the URL parameters. The same variables in all four;
  • How it replaces: always with text. An absent or null value becomes an empty string, never the word null;
  • If the JSON is not valid after the replacement, the body is sent as plain text instead of an object. It is worth checking the quotes around each variable.

⚠️ There are 11 variables, against the 124 fields of the ready-made body. Anyone who needs company, tags, products, custom fields or conversation data cannot build that by hand — for those cases, the path is to use GetRaze data and handle the body on the other end.

VariableWhere it comes fromExample
{{contato.nome}}The contact's full nameAna Example
{{contato.primeiro_nome}}First name; failing that, the first word of the nameAna
{{contato.email}}The contact's emailana@example.com
{{contato.telefone}}Phone, E.164 with ++5511900000000
{{contato.empresa}}The contact's "company" field, as textExample Health
{{contato.cargo}}The contact's job titleHead of Operations
{{oportunidade.titulo}}The run's deal titleAI Support rollout
{{oportunidade.valor}}Value, with no symbol or thousands separator74500
{{etapa.nome}}The trigger's stageQualified
{{pipeline.nome}}The trigger's funnelSales
{{usuario.nome}}Who fired it, when there was someoneBeto Example
{{resposta.nome_do_campo}}A field saved from the response of an earlier HTTP Request in the same automation{{resposta.rd_uuid}}

💡 The variable names are in Portuguese in every language — they are identifiers the platform resolves, not display text.

Example of a custom body ​

json
{
  "name": "{{contato.nome}}",
  "email": "{{contato.email}}",
  "phone": "{{contato.telefone}}",
  "company": "{{contato.empresa}}",
  "deal": {
    "title": "{{oportunidade.titulo}}",
    "value": "{{oportunidade.valor}}",
    "funnel": "{{pipeline.nome}}",
    "stage": "{{etapa.nome}}"
  },
  "source": "getraze"
}

"value" comes out as text, because the replacement is textual. For a number, the other end converts it — or use GetRaze data, where opportunity.value is already numeric.


Next steps ​

GetRaze - AI-Powered Lead Generation