Webhook
Dispatches an outbound webhook request.
Type key
webhook
HTTP Methods
GET- Retrieves a resource.POST- Submits a payload and is used whenmethodis omitted.PUT- Replaces a resource with the supplied payload.PATCH- Partially updates a resource.DELETE- Deletes a resource.
Authentication Types
basic- Sends an HTTP Basic Authorization header fromauth.basiccredentials.header- Sends the configuredauth.headername and value.jwt- Sends a generated bearer token.secret- Signs the webhook request withauth.secret.secret.
Config keys
url
string
yes
Target URL for the webhook request. Must be a valid active URL.
headers
object
yes (present)
Custom request headers as key-value map.
auth
object | null
no
Optional auth configuration.
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