Skip to main content

Slack

Post deployment notifications to a Slack channel.

Setup

  1. Create a Slack app and Incoming Webhook.
  2. Add VORTEX_NOTIFY_SLACK_WEBHOOK to your hosting provider's environment variables.

Environment variables

VariableRequiredDefaultLocationDescription
VORTEX_NOTIFY_SLACK_WEBHOOKYesHostingSlack webhook URL
VORTEX_NOTIFY_SLACK_PROJECTNoVORTEX_NOTIFY_PROJECT.envProject name
VORTEX_NOTIFY_SLACK_MESSAGENoDefault template.envFallback text template
VORTEX_NOTIFY_SLACK_CHANNELNo.envTarget channel (overrides webhook default)
VORTEX_NOTIFY_SLACK_USERNAMENoDeployment Bot.envBot display name
VORTEX_NOTIFY_SLACK_ICON_EMOJINo:rocket:.envBot icon emoji
VORTEX_NOTIFY_SLACK_BRANCHESNo.envRestrict to specific branches (comma-separated)

Event behavior

Slack notifications are sent for both pre_deployment and post_deployment events:

  • Pre-deployment: Gray color with "Deployment Starting" status
  • Post-deployment: Green color with "Deployment Complete" status

Example

Slack notification - Deployment Complete