For the complete documentation index, see llms.txt. This page is also available as Markdown.

Webhook

Dispatches an outbound webhook request.

Type key

webhook

Config keys

Key
Type
Required
Description

url

string

yes

Target URL for the webhook request. Must be a valid active URL.

method

string | null

no

HTTP method. Allowed values: GET, POST, PUT, PATCH, DELETE. Default at runtime: POST.

headers

object

yes (present)

Custom request headers as key-value map.

auth

object | null

no

Optional auth configuration.

auth.type

string | null

no

Auth type: basic, header, jwt, secret.

auth.basic.username

string

conditional

Required when auth.type = basic.

auth.basic.password

string

conditional

Required when auth.type = basic.

auth.header.name

string

conditional

Required when auth.type = header.

auth.header.value

string

conditional

Required when auth.type = header.

auth.secret.secret

string

conditional

Required when auth.type = secret.

Webhook config values are used as plain strings. System variables are currently not resolved in webhook config fields.

Example config

Last updated