Skip to content

Webhook

  • Type trigger.webhook
  • Group Triggers
  • Role trigger
  • Risk reads only
  • Side effect none
  • Runs once per execution
  • Needs network
  • Credentials header, basic, bearer, query

Starts when an HTTP request reaches its URL

method

Method · string · required · default POST · one of GET, POST, PUT, PATCH, DELETE

The HTTP method of the request.

path

Path · string · required

auth

Authentication · string · optional · default none · one of none, header, basic

credentialId

Credential · string · optional

A saved credential from the vault; it adds the authentication for you.

Shown when auth is header, basic.

respond

Respond · string · optional · default immediately · one of immediately, lastNode, respondNode

signature

Signature check · string · optional · default none · one of none, hmac

signatureHeader

Signature header · string · optional · default X-Signature

Shown when signature is hmac.

signatureAlgorithm

Signature algorithm · string · optional · default sha256 · one of sha256, sha1, sha512

Shown when signature is hmac.

signatureEncoding

Signature encoding · string · optional · default hex · one of hex, base64

Shown when signature is hmac.

signaturePrefix

Signature prefix · string · optional

Shown when signature is hmac.

signatureCredentialId

Signing secret · string · optional

Shown when signature is hmac.

rawBody

Include the raw body · boolean · optional · default false

  • main

← All nodes