Zum Hauptinhalt springen

Webhook

Category: Integration
Node id: webhook

Sends HTTP webhook requests with configurable method, headers, authentication, and retry logic

What it does​

  • Sends HTTP requests with configurable method (GET/POST/PUT/PATCH/DELETE/HEAD)
  • Multiple content types: JSON, form-urlencoded, plain text, XML
  • Authentication: Bearer token, Basic auth, API key
  • Configurable retry logic with delay between attempts
  • Custom HTTP headers from config or input (input overrides config)
  • Automatic JSON response parsing with raw body fallback
  • Configurable request timeout

Use cases​

  • Send pipeline results to an external webhook endpoint
  • Notify third-party services of completed data processing
  • POST FHIR resources to external healthcare systems
  • Trigger downstream workflows in other platforms via HTTP

Runtime​

  • Performance tier: variable

Input ports​

NameTypeRequiredDescription
urltextNoURL to send the webhook to (overrides config)
bodyanyNoRequest body payload
headersjsonNoHTTP headers to include (overrides config headers)

Output ports​

NameTypeRequiredDescription
resultjsonNoFull webhook response with status_code, status, headers, body, and body_raw
successbooleanNoWhether the request succeeded

Settings​

Basic​

SettingNameTypeRequiredDefaultAllowed valuesDescription
URLurlstringYesWebhook URL to call
HTTP MethodmethodenumNoPOSTGET, POST, PUT, PATCH, DELETE, HEADHTTP method to use
Content Typecontent_typeenumNoapplication/jsonapplication/json, application/x-www-form-urlencoded, text/plain, application/xmlRequest content type

Auth​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Auth Typeauth_typeenumNononenone, bearer, basic, api_keyAuthentication type
Bearer Tokenauth_tokensecretNoBearer token for authentication
Usernameauth_usernamestringNoUsername for basic authentication
Passwordauth_passwordsecretNoPassword for basic authentication
API Keyapi_keysecretNoAPI key value
API Key Headerapi_key_headerstringNoX-API-KeyHeader name for API key

Advanced​

SettingNameTypeRequiredDefaultAllowed valuesDescription
HeadersheadersjsonNoCustom HTTP headers as key-value pairs
BodybodyjsonNoRequest body (used if no body input is connected)
Timeout (seconds)timeoutnumberNo30min 1Request timeout in seconds
RetriesretriesnumberNo0min 0Number of retry attempts on failure
Retry Delay (seconds)retry_delaynumberNo1min 0Delay between retries in seconds

Errors​

CodeDescription
MISSING_URLURL is required but was not provided in config or input
REQUEST_FAILEDHTTP request failed after all retry attempts
AUTH_TOKEN_MISSINGauth_token is required for bearer authentication but was empty
AUTH_CREDENTIALS_MISSINGUsername and password are required for basic authentication
HTTP_ERRORServer returned an HTTP status code >= 400

Runtime notes​

  • HTTP 4xx/5xx responses cause the node to error — check status_code in result only on success
  • Input headers override config headers by key; both are merged into the final request
  • body_raw is always a string; body is parsed JSON if possible, otherwise falls back to the raw string
  • Retries use a fixed delay (retry_delay seconds) between attempts with no exponential backoff

See Build any workflow for how to put nodes together and Ports, types and data flow for how port types connect.

Etwas unklar? Senden Sie Feedback zur Dokumentation per E-Mail..