Skip to main content

Webhook

Send HTTP requests to arbitrary webhook URLs.

Setup

  1. Add VORTEX_NOTIFY_WEBHOOK_URL to your .env file or hosting environment variables.

Environment variables

VariableRequiredDefaultLocationDescription
VORTEX_NOTIFY_WEBHOOK_URLYes.env or HostingWebhook endpoint URL
VORTEX_NOTIFY_WEBHOOK_METHODNoPOST.envHTTP method
VORTEX_NOTIFY_WEBHOOK_HEADERSNoContent-Type: application/json.envPipe-separated headers
VORTEX_NOTIFY_WEBHOOK_PAYLOADNoDefault template.envJSON payload
VORTEX_NOTIFY_WEBHOOK_RESPONSE_STATUSNo200.envExpected HTTP status
VORTEX_NOTIFY_WEBHOOK_BRANCHESNo.envRestrict to specific branches (comma-separated)

Default payload template

{
"channel": "Channel 1",
"message": "%message%",
"project": "%project%",
"label": "%label%",
"timestamp": "%timestamp%",
"environment_url": "%environment_url%",
"login_url": "%login_url%"
}

The %message% token expands to the full deployment message with all other tokens replaced.