DocsNodesDoes somethingCall a URL

Call a URL

Calls any HTTP endpoint: Home Assistant, a spreadsheet script, your own server. The answer comes back into the run, and a failed call can leave by error.

Kindaction:webhook
GroupDoes something
Credits5 credits
Ports out2

How it looks

Settings

SettingRequiredWhat it does
MethodmethodYesGET, POST, PUT, PATCH, DELETE, HEAD or OPTIONS.
URLurlYesThe address. With an integration, it can be a path under the integration's base URL.
AuthenticationintegrationRefNoAn HTTP auth or Home Assistant integration. Its credential is added for you and only ever sent to its own address.
HeadersheadersNoUp to 20 extra headers. Never put a credential here: that's what the integration is for.
BodybodyNoJSON to send. Values from the run can go in.
TimeouttimeoutSecondsNoSeconds to wait for the answer, 1–60. 30 by default.

Ports

PortThe run leaves by it when
defaultThe call answered with a success.
errorWith On failure set to continue: the call failed after its retries.

What it adds to the run

Later nodes can read these, in a condition or as {{name}} in a text field.

ValueHolds
statusThe HTTP status.
bodyThe answer as text, up to 256 KB.
jsonThe answer, parsed, when it was JSON. Read json.state in a later node.
What it won't doRedirects aren't followed, and private or reserved addresses (your home network) are refused. To reach a box at home, expose it through a tunnel or use Home Assistant Cloud. 5xx, timeouts and network errors are retried; 4xx isn't.

Problems you might see

CodeMeans
WEBHOOK_HTTP_ERRORThe server answered with an error status.
WEBHOOK_TIMEOUTNo answer within the timeout.
WEBHOOK_BLOCKED_TARGETThe address is private or reserved.
WEBHOOK_ORIGIN_MISMATCHThe URL points somewhere other than the integration's own address.
WEBHOOK_RESPONSE_TOO_LARGEThe answer was over 256 KB.

Problems found when you publish stop the publish and point at the node. Problems while a run is going fail the node, and its On failure setting decides what happens next. See the error codes for the API's own.