API Step

The API Step lets you call external services from your quiz flow. Use it to send respondent data to tools like CRMs or webhooks, or fetch data and store it for later steps and completion content.

Unlike question blocks, the API Step runs in the background and does not render as a respondent-facing prompt.

When to use the API Step

• Send quiz answers, lead fields, tags, or scores to external systems.
• Pull data from an API and map response fields into quiz variables.
• Add failure routing when a request fails and you need a fallback path.

What you can configure

• HTTP method: GET, POST, PUT, PATCH, DELETE
• Endpoint URL
• Headers
• Query parameters
• Body mode: None or Raw (JSON/text)
• Capture response mappings (save API response paths into variables)
• Optional failure destination

Variable placeholders

You can use placeholders in endpoint URL, headers, query params, and raw body values:

• {{variable_key}}

Example raw JSON body:

{
  "name": "{{full_name}}",
  "email": "{{email}}",
  "score": "{{total_score}}"
}

Test with Send

Use Send in the builder to test the request configuration. If your body includes placeholders, the builder asks for test values first so you can validate interpolation before running.

After a test run, review:

• Status code
• Response body
• Response headers
• JSON paths available for capture mappings

Capture response values

Use Capture response to map API response fields into quiz variables.

Path format starts with response, for example:

• response.records[0].id
• response.data.user.email

Captured values can be reused in later steps, Jump Logic, and completion content.

Failure path behavior

• Failure path off: quiz continues to the next block/step.
• Failure path on: quiz routes to your selected failure destination.

Use this for fallback copy, recovery prompts, or alternate conversion paths when the external API is unavailable.

Performance and security notes

• If you do not capture response values and do not define a failure path, the flow can continue while the API call finishes in the background.
• Credentials are handled server-side and are not exposed to respondents.
• Sensitive headers are redacted in diagnostics.

Step-by-step

1. Add an API Step in the Questions flow where the request should run.
2. Configure method, endpoint, headers, query params, and optional body.
3. Use placeholders for values already captured in the quiz.
4. Click Send to test and confirm the response shape.
5. Map response paths into variables if later logic or copy depends on them.
6. Enable Failure path only when you need a specific fallback destination.

Troubleshooting quick checks

• 401 Authentication required: verify auth header format.
• 403 Invalid permissions: verify token scope/permissions.
• 422 Invalid request body: validate JSON shape and field names.

Checklist:

1. Confirm Authorization: Bearer <token> format.
2. Confirm Content-Type: application/json when sending JSON.
3. Validate raw JSON syntax.
4. Confirm placeholders use {{variable_key}}.
5. Re-test in Postman/cURL if you need parity checks.