Output · Send and serve

HTTP Request

Sends the data to a web address with POST, PUT or PATCH, as JSON, form fields or a file. For example, push results to a webhook.

Also known as: Webhook, API call

How it works

Type the URL and pick the Method: POST (the default), PUT or PATCH. Body sets how the data is sent: json writes the Body template, which is JSON with tokens replaced at send time, {{rows}} (the rows as a JSON array), {{count}}, {{columns}} and {{date}}, and defaults to {"rows": {{rows}}}; form sends the Form fields you list, whose values accept the same tokens; binary uploads the incoming file as the body; none sends no body. Add Headers as key and value pairs. Auth (Bearer) picks a credential from the vault whose token is sent as a bearer header. Batch size, for json and form bodies, splits the rows into several requests of that many rows; blank sends everything in one. Timeout (s) is 30 by default.

Inputs and outputs

Inputs

data — Any

Outputs

None — this node starts a workflow.

Settings

The Attributes panel with a HTTP Request node selected.

The Attributes panel of HTTP Request, as in the app: the controls work, but nothing runs — there is no data behind it.

The same settings, as the Assistant writes them

{
  url: string
  method: "POST"|"PUT"|"PATCH"
  bodyType: "none"|"json"|"form"|"binary"
  bodyTemplate?: string
  formFields?: {key,value}[]
  headers?: {key,value}[]
  credentialName?: string
  batchSize?: number|null
  timeoutSeconds: number
}

bodyTemplate (bodyType "json") is JSON with template tokens replaced when it sends: {{rows}} (the rows as a JSON array), {{count}}, {{columns}} and {{date}}, e.g. '{"rows": {{rows}}}'

Example

Push new leads to a webhook 200 at a time. URL https://hooks.example.com/leads, Method POST, Body json with the default template, Batch size 200, a header X-Source: daedalus and the webhook credential under Auth (Bearer).