Respond to HTTP request

respondToHttpRequest sends a status, headers, and body to one exact onHttpRequest occurrence. Passing the request’s ID makes the trigger wait automatically unless its waitForResponse option explicitly overrides that behavior.

Example

automations/http-response.automation.ts

import { automation, onHttpRequest, respondToHttpRequest } from "automate.ax"

export default automation("Respond with JSON", () => {
  const request = onHttpRequest({ scope: "automation" })

  respondToHttpRequest({
    body: { accepted: true },
    requestId: request.requestId,
  })
})

Inputs

Input	Type	Required	Default	Description
`body`	`string \| Blob \| JSON value \| null`	No	No body	Response payload. `respondToHttpRequest` serializes JSON values automatically.
`headers`	`Record<string, string>`	No	`{}`	Response headers.
`requestId`	`string`	Yes	—	`request.requestId` from the HTTP request that should receive this response.
`status`	`number`	No	`200` with a body or `204` without one	HTTP status from 100 through 599.

Unless you provide content-type, respondToHttpRequest uses application/json for JSON, text/plain;charset=UTF-8 for strings, and the Blob’s media type. A Blob without a media type uses application/octet-stream. Every input accepts a compatible signal. respondToHttpRequest returns Signal<void>. onHttpRequest waits up to 55 seconds for a response with its request ID. If execution finishes without one, the caller receives 500. If execution is still active after 55 seconds, the caller receives 504, and the automation may keep running. An output addressed to another correlated HTTP request is ignored.

Built-in triggers

Built-in actions

Runtime utilities

Integrations

Respond to HTTP request

Example

Inputs

​Example

​Inputs

Example

Inputs