efrecon/mattermost
Notifies Mattermost via incoming WebHooks
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| url | URL to incoming WebHook. See following URL for how to generate if your destination channel does not already have one hook. https://docs.mattermost.com/developer/webhooks-incoming.html#simple-incoming-webhook | yes | "" |
| text | Markdown-formatted message to display in the post. To trigger notifications, use @<username>, @channel, and @here like you would in normal Mattermost messaging. | yes | "" |
| channel | Overrides the channel the message posts in. Use the channel’s name and not the display name, e.g. use “town-square”, not “Town Square”. Use an “@” followed by a username to send to a Direct Message. | no | — |
| username | Overrides the username the message posts as. Defaults to the username set during webhook creation or the webhook creator’s username if the former was not set. | no | GitHub Action |
| icon_url | Overrides the profile picture the message posts with. Defaults to the URL set during webhook creation or the webhook creator’s profile picture if the former was not set. | no | https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png |
| icon_emoji | Overrides the profile picture and icon_url parameter. Defaults to none and is not set during webhook creation. | no | — |
| props | Sets the post props, a JSON property bag for storing extra or meta data on the post. Mainly used by other integrations accessing posts through the REST API. If you want to add an extra card, use the card input instead. | no | — |
| card | Props card allows for extra information (Markdown-formatted text) to be sent to Mattermost that will only be displayed in the RHS panel after a user selects the info icon displayed alongside the post. | no | # GitHub Information\n \n ## Action Information\n \n actor: ${{ github.actor }}\n\n event: ${{ github.event_name }}\n\n ref: ${{ github.ref }}\n\n repository: ${{ github.repository }}\n\n sha: ${{ github.sha }}\n\n workflow: ${{ github.workflow }}\n\n \n ## Runner Information\n \n runner: ${{ runner.name }}\n\n OS: ${{ runner.os }}\n\n \n |
| options | Additional options to mattermost wrapper, e.g. -v to print out additional verbose information. This is a semi-internal input and should only be used for debugging. | no | "" |
Outputs
no outputs