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.
Kind
action:webhookGroupDoes something
Credits5 credits
Ports out2
How it looks
Settings
| Setting | Required | What it does |
|---|---|---|
| Methodmethod | Yes | GET, POST, PUT, PATCH, DELETE, HEAD or OPTIONS. |
| URLurl | Yes | The address. With an integration, it can be a path under the integration's base URL. |
| AuthenticationintegrationRef | No | An HTTP auth or Home Assistant integration. Its credential is added for you and only ever sent to its own address. |
| Headersheaders | No | Up to 20 extra headers. Never put a credential here: that's what the integration is for. |
| Bodybody | No | JSON to send. Values from the run can go in. |
| TimeouttimeoutSeconds | No | Seconds to wait for the answer, 1–60. 30 by default. |
Ports
| Port | The run leaves by it when |
|---|---|
default | The call answered with a success. |
error | With 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.
| Value | Holds |
|---|---|
status | The HTTP status. |
body | The answer as text, up to 256 KB. |
json | The 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
| Code | Means |
|---|---|
WEBHOOK_HTTP_ERROR | The server answered with an error status. |
WEBHOOK_TIMEOUT | No answer within the timeout. |
WEBHOOK_BLOCKED_TARGET | The address is private or reserved. |
WEBHOOK_ORIGIN_MISMATCH | The URL points somewhere other than the integration's own address. |
WEBHOOK_RESPONSE_TOO_LARGE | The 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.
See also
Runs the body once per item of a list, one after another, then leaves by done.
Outbodydonecontrol:foreachChecks a condition, or several joined with and or or, and leaves by true or false.
Outtruefalsecontrol:logicStarts when something outside WBSKT posts to the workflow's own URL. The body becomes the run's input.
Outdefaulttrigger:webhook