rjstone/Discord Webhook Notify
Send notifications to Discord using a webhook. Works with all execution environments including windows, macos, and linux.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| webhookUrl | Discord webhook URL. Should be stored in a repo secret (Settings>Security>Secrets) and inserted in the action call as a context expression. | yes | — |
| flags | A whitespace-separated list of MessageFlags. The only one supported currently is SuppressNotifications. | no | "" |
| username | Username to display in discord. Must be 2-32 chars long and can't contain: @, #, :, ```, discord Also can't be "here" or "everyone", for obvious reasons. | no | Notification (Github Actions) |
| avatarUrl | URL to png of discord avatar to use. Default is the GitHub monochrome mark cat logo. May not work depending on Discord policy. | no | https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png |
| text | Text to be sent as normal text above the embed. Defaults to empty string. | no | — |
| severity | Severity level - info, warn, error, or none. Using "none" will cause no embed to be added. Using any other value will cause an embed with a set of matching defaults to be added. | no | none |
| color | Notification embed color in the form #rrggbb (hex). Default determined by severity. | no | — |
| title | Title for the embed. Defaults to severity long terminology. | no | — |
| description | Embed notification message. Default provides some minimal github.context workflow info. | no | — |
| details | Additional text after the description in case you want to retain the default embed description. Defaults to empty string. | no | — |
| footer | Footer for the embed. Defaults to long terminology severity. | no | — |
| processingOptions | (EXPERIMENTAL) Set to "percentDecode" if you want some inputs that are often multi-line strings to be run through "percent decoding" using decodeURIComponent(). This can be useful in cases where the output from another action should contain newlines, but won't be preserved by the Workflow system if it does. | no | "" |
| holddownTime | The minimum amount of time in miliseconds between successive notifications to avoid triggering Discord's rate limiting. | no | 3000 |
| lockfileDir | The directory where the lockfile used for saving last run time is stored. | no | . |
Outputs
no outputs