Documentation
AutomationBlocks

HTTP Request Block

Call an external API from an automation funnel.

Use HTTP request to send data from the current automation run to an external service.

Configure the Request

  1. Add HTTP request to a step.
  2. Select GET, POST, PUT, PATCH, or DELETE.
  3. Enter the full request URL in API.
  4. Add query parameters when the endpoint expects URL parameters.
  5. Add request headers, such as authorization or content negotiation.
  6. Choose a body type and complete its fields.
  7. Open Checklist, save, and test with a non-production client.

Request Fields

FieldPurpose
APIFull endpoint URL. Required.
ParametersKey-value pairs added to the URL query string.
HeadersKey-value pairs sent as HTTP headers.
Body typeEncoding used for the request payload.
BodyPayload sent for body types that require content.

Keys and values can use expressions. This makes it possible to send client, message, funnel, and environment data.

Body Types

Body typeUse it for
noneRequests without a payload, commonly GET or DELETE.
form-dataMultipart key-value fields, typically used by form or upload endpoints.
x-www-form-urlencodedForm fields encoded in a single URL-encoded body.
JSONStructured API payloads. Enter valid JSON.
rawPlain text or a service-specific payload.

When a body type other than none is selected, its body cannot be empty.

Expression Example

Request URL:

{env.API_URL}/tickets

Headers:

KeyValue
AuthorizationBearer {env.API_TOKEN}
Content-Typeapplication/json

JSON body:

{
  "client_id": "{sys.client.id}",
  "client_name": "{sys.client.name}",
  "message": "{sys.message.text}",
  "priority": "{funnel.priority}"
}

Store reusable endpoint and credential values as environment variables. Do not place long-lived secrets directly in message text or client-visible fields.

Order and Failure Planning

Put Set variable and client-update blocks before the request if the request reads their new values. Put a confirmation message after the request only when it should run after the call.

Design a separate path for cases where an external service is unavailable. During testing, verify timeouts, authorization failures, invalid payloads, and unexpected response data against the receiving service.

Validation and Troubleshooting

Save Is Disabled

The URL is required. The selected body format must contain data, and every expression must be valid. Open Checklist to jump to the affected block.

The API Rejects the Request

Check the method, URL, required headers, body encoding, and credentials. For JSON, confirm that the rendered result remains valid JSON when variables contain quotes or empty values.

The Wrong Runtime Value Is Sent

Confirm the variable prefix and block order. Use sys.* for runtime context, funnel.* for mutable run data, and env.* for configuration.

On this page