Fetch API Data
Run a reusable API request endpoint and store its JSON response for later nodes.
The Fetch API Data node calls a reusable API request endpoint from a campaign workflow and stores the JSON response under an output key.
When to use it
Use this node when campaign logic or email content needs data from another system.
Common examples:
- fetch account or subscription details before branching
- personalize an email with external recommendations
- look up eligibility before continuing a workflow
- feed data from one API request into a later request
Settings
- Node name: optional display name shown on the workflow canvas.
- API request endpoint: the reusable endpoint to call.
- Output key: the workflow key where the response is stored, such as
customer_profile. - Simulation mock response: sample JSON used during simulations.
- Simulation mock status: HTTP status used to simulate success or failure responses.
- On Failure: controls whether a failed request stops the execution or allows the workflow to continue.
Using the response later
If the output key is customer_profile, later workflow steps can reference response fields under workflow.customer_profile.
{{ workflow.customer_profile.plan }}
{{ workflow.customer_profile.account.id }}
{{ workflow.customer_profile.recommendations.0.name }}
If / Else branches can also use API output conditions to route contacts based on the stored response.
Simulation and execution behavior
Simulations use the mock response and mock status configured on the node. Real executions call the selected API request endpoint.
The response must be valid JSON and is stored only after the node succeeds. If the node fails and On Failure is set to continue, later nodes should be designed to handle missing output data.
Best practices
- Choose a short, descriptive output key.
- Keep mock responses close to the real response shape.
- Use the mock status to test failure behavior before publishing.
- Add If / Else checks when later steps depend on optional response fields.