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
| Rule | What it means |
|---|---|
| Fixed shape | The 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 messages | The 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 null | A block with no data becomes null, it never disappears. An empty list becomes []. A contact trigger, with no opportunity, sends "opportunity": null |
| Unticking cuts | A 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:
| Key | What it is |
|---|---|
event | Always automation.run |
sent_at | When the request left, in ISO 8601 |
test | true when the send came from the Test request button, and not from a real run |
automation | The automation's id and name |
account | The account's id and name |
💡
testis what lets the other end ignore your tests without creating duplicate records. Worth handling on the very first integration.
The complete body
{
"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.
| Field | Type | Note |
|---|---|---|
type | string | stage_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_id | uuid | Opportunity triggers. Comes with pipeline_name |
payload.stage_id | uuid | Stage triggers. Comes with stage_name |
payload.from_stage_id | uuid · null | Source stage. null when the card was born in the stage instead of being moved — that is what separates "created" from "moved" |
payload.tag_id | uuid | Only on tag_added and tag_removed |
payload.channel_account_id | uuid | Conversation triggers |
payload.sector_id | uuid | Only on conversation_assigned |
payload.source | string | Only on contact_created. The contact's source |
payload.days | number | Only on opportunity_stalled. Comes with stalled_since |
payload.label | string · null | The run's readable label, as it appears under Runs |
payload.depth | number | Chaining 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.
| Field | Type | Note |
|---|---|---|
id | uuid | |
name | string | Full name, as it was registered |
first_name | string · null | Only when it came in separately from the source. It is not derived from name |
last_name | string · null | |
email | string · null | |
phone | string · null | Always E.164 with + |
company | string · null | The text typed on the contact. For the registered company, use the company block |
title | string · null | Job title |
type | string · null | lead or client |
source | string · null | linkedin, import, instagram_captura, whatsapp_qr… |
timezone | string · null | IANA, e.g. America/Sao_Paulo |
owner | object · null | Owner: id, name, email |
sector | object · null | id, name |
tags | array | Each item: id, name, color. In alphabetical order |
custom_fields | object | The key is the field's identifier, not its on-screen label. {} when there are none |
channels | array | Each item: provider, identifier. Active channels only |
last_interaction_at | timestamp · null | |
created_at | timestamp | |
url | string | Direct 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.
| Field | Type | Note |
|---|---|---|
id | uuid | |
name | string | |
domain | string · null | |
website | string · null | |
industry | string · array · null | When it came from enrichment, it is an array of names in English. When it was typed, it is text |
size | string · null | Range, e.g. 501-1000 |
headquarters | string · null | Empty across most of the base |
locations | object · null | Free-form structure coming from enrichment |
icp_fit | number · null | 0 to 100. null means "not evaluated", not "does not fit" |
tier | number · null | ABM tier |
revenue_range | string · null | Empty across most of the base |
Opportunity — opportunity
The run's deal. null on triggers that have none — contact created, tag, conversation.
| Field | Type | Note |
|---|---|---|
id | uuid | |
title | string | |
value | number · null | |
currency | string | BRL when it was not defined |
probability | number | 0 to 100 |
status | string | open, won or lost. It is derived from won_at and lost_at; there is no status column in the database |
pipeline | object · null | id, name |
stage | object · null | id, name, is_win, is_loss |
owner | object · null | id, name, email |
expected_close_date | date · null | |
products | array | Each item: id, name, quantity, price. The price is the unit price |
tags | array | The opportunity's tags, distinct from the contact's |
custom_fields | object | |
won_at / lost_at | timestamp · null | |
loss_reason | string · null | The reason's name, not its id |
created_at | timestamp | |
url | string | Opens 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.
| Field | Type | Note |
|---|---|---|
id | uuid | |
title | string | |
pipeline | string · null | Here it is the name, not an object |
stage | string · null | Same |
value | number · null | |
currency | string | |
status | string | open, 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.
| Field | Type | Note |
|---|---|---|
id | uuid | |
channel | object · null | id, provider, name, identifier. The provider is the channel type: whatsapp, instagram, linkedin, email… |
status | string | ai_active, manual or closed |
ai_active | boolean | |
manual_control_taken | boolean | true when a human took over. It is the brake that keeps the AI from coming back on its own |
assigned_user | object · null | Who is handling it |
sector | object · null | |
messages_count | number · null | |
unread_count | number | |
last_message_at | timestamp · null | |
last_message_direction | string · null | inbound or outbound |
last_message_preview | string · null | Only the last one, truncated. It is the closest to content the body carries |
summary | string · null | Summary written by the AI, when one exists |
campaign | object · null | The campaign that started the conversation |
opened_at | timestamp | |
url | string | Opens 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.
| Field | Type | Note |
|---|---|---|
open | number | Counting is capped at 50 |
overdue | number | Of the open ones, how many are already past due |
next | object · null | The 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, notplaybooks. The screen was renamed; the request body kept the old name so it would not break anyone who had already integrated.
| Field | Type | Note |
|---|---|---|
id | uuid | The run's id, not the template's |
name | string | The playbook's name at the moment it ran |
status | string | in_progress, completed or cancelled |
progress | string | Text in the "3/8" format, not a number |
started_at | timestamp |
Calendar — calendar
Only the contact's or conversation's next confirmed meeting. Past or cancelled events do not come in.
| Field | Type | Note |
|---|---|---|
next_event | object · null | null when none is scheduled |
next_event.id | uuid | |
next_event.title | string | |
next_event.starts_at / ends_at | timestamp | |
next_event.meet_url | string · null | The 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.
| Variable | Where it comes from | Example |
|---|---|---|
{{contato.nome}} | The contact's full name | Ana Example |
{{contato.primeiro_nome}} | First name; failing that, the first word of the name | Ana |
{{contato.email}} | The contact's email | ana@example.com |
{{contato.telefone}} | Phone, E.164 with + | +5511900000000 |
{{contato.empresa}} | The contact's "company" field, as text | Example Health |
{{contato.cargo}} | The contact's job title | Head of Operations |
{{oportunidade.titulo}} | The run's deal title | AI Support rollout |
{{oportunidade.valor}} | Value, with no symbol or thousands separator | 74500 |
{{etapa.nome}} | The trigger's stage | Qualified |
{{pipeline.nome}} | The trigger's funnel | Sales |
{{usuario.nome}} | Who fired it, when there was someone | Beto 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
{
"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
- Go back to the HTTP Request action for the remaining fields — authentication, headers, timeout and what to do on failure;
- Build the automation that will fire the call in Creating an automation.