Skip to Content
DocsReferences

Configuration Reference

Complete list of all inputs for Workflow Blabber.

Required Inputs

InputDescriptionExample
channelsComma-separated list of channels'email,discord,slack,telegram'
statusWorkflow status${{ job.status }} or 'success', 'failure', 'cancelled'

General Inputs

InputDescriptionDefaultRequired
custom_titleCustom notification titleAuto-generatedNo
custom_messageCustom notification messageAuto-generatedNo
fail_on_errorFail action if notification fails'false'No

Email Inputs

InputDescriptionRequired
smtp_hostSMTP server hostnameYes
smtp_portSMTP server portYes
smtp_userSMTP usernameYes
smtp_passwordSMTP passwordYes
recipient_emailRecipient email addressYes
smtp_secureUse TLS/SSL ('true' or 'false')No (default: 'false')
email_subjectEmail subject lineNo

Common SMTP Ports

PortProtocolUsage
587STARTTLSRecommended
465SSL/TLSSecure from start
25UnencryptedNot recommended

Discord Inputs

InputDescriptionRequired
discord_webhook_urlDiscord webhook URLYes

Slack Inputs

InputDescriptionRequired
slack_webhook_urlSlack webhook URLYes

Telegram Inputs

InputDescriptionRequired
telegram_bot_tokenBot token from @BotFatherYes
telegram_chat_idChat or group IDYes

Complete Example

.github/workflows/ci.yml
- name: Notify if: always() uses: michaelikoko/workflow-blabber@v1 with: # Required channels: 'email,discord,slack,telegram' status: ${{ job.status }} # General (optional) custom_title: 'Production Build' custom_message: 'Build completed successfully' fail_on_error: 'false' # Email smtp_host: 'smtp.gmail.com' smtp_port: '587' smtp_user: ${{ secrets.SMTP_USER }} smtp_password: ${{ secrets.SMTP_PASSWORD }} recipient_email: ${{ secrets.RECIPIENT_EMAIL }} smtp_secure: 'false' email_subject: 'CI Build Status' # Discord discord_webhook_url: ${{ secrets.DISCORD_WEBHOOK }} # Slack slack_webhook_url: ${{ secrets.SLACK_WEBHOOK }} # Telegram telegram_bot_token: ${{ secrets.TELEGRAM_BOT_TOKEN }} telegram_chat_id: ${{ secrets.TELEGRAM_CHAT_ID }}

Status Values

ValueDescription
successWorkflow completed successfully
failureWorkflow failed
cancelledWorkflow was cancelled

Channel Values

Specify one or more channels separated by commas:

# Single channel channels: 'discord' # Multiple channels channels: 'email,discord,slack,telegram'

Available channels: email, discord, slack, telegram

Last updated on