Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mikesprague/teams-incoming-webhook-action
GitHub Action that sends an AdaptiveCard notification to an MS Teams Incoming Webhook
https://github.com/mikesprague/teams-incoming-webhook-action
actions adaptive-cards adaptivecards github-actions ms-teams msteams webhook
Last synced: 7 days ago
JSON representation
GitHub Action that sends an AdaptiveCard notification to an MS Teams Incoming Webhook
- Host: GitHub
- URL: https://github.com/mikesprague/teams-incoming-webhook-action
- Owner: mikesprague
- License: mit
- Created: 2021-09-13T20:25:33.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T14:20:57.000Z (30 days ago)
- Last Synced: 2024-10-18T09:14:25.065Z (28 days ago)
- Topics: actions, adaptive-cards, adaptivecards, github-actions, ms-teams, msteams, webhook
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/ms-teams-incoming-webhook-notification
- Size: 4.86 MB
- Stars: 23
- Watchers: 5
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-adaptive-cards - MS Teams Incoming Webhook - GitHub Action that sends an AdaptiveCard notification to an MS Teams Incoming Webhook. (Uncategorized / Uncategorized)
README
# teams-incoming-webhook-action
[](https://github.com/mikesprague/teams-incoming-webhook-action/actions/workflows/build-and-test.yml)
[](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=406118991)
Sends an [AdaptiveCard](https://adaptivecards.io/explorer/) notification to an [MS Teams Incoming Webhook](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook) from a GitHub Action Workflow
This action requires a secret to be set up with your Teams Incoming Webhook URL named `MS_TEAMS_WEBHOOK_URL` ([official docs for creating secrets in your repo](https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository))
- [Inputs](#inputs)
- [Example Usage](#example-usage)
- [Simple Notification](#simple-notification)
- [Workflow Status Notifications](#workflow-status-notifications)
- [Info Notification](#info-notification)
- [Cancel Notification](#cancel-notification)
- [Failure Notification](#failure-notification)
- [Success Message](#success-message)
## Inputs
- `github-token`
- **required:** true
- **type:** string
- **description:** GitHub Token for API operations (see examples for how to reference)
- **example:** `github-token: ${{ github.token }}`
- `webhook-url`
- **required:** true
- **type:** string
- **description:** MS Teams Incoming Webhook URL
- **example:** `webhook-url: ${{ secrets.MS_TEAMS_WEBHOOK_URL }}`
- `title`
- **required:** true
- **type:** string
- **description:** Message title or heading
- **example:** `title: "Test Message Heading"`
- `message`
- **required:** false
- **type:** string
- **default:** `""`
- **description:** Message to be sent (not used for workflow status notifications)
- **example:** `message: "This is some test message content for a simple notification"`
- `color`
- **required:** false
- **type:** string
- **default:** `"default"`
- **description:** Background color of the heading in the message - accepts `default`, `info`, `success`, `failure`, `warning` as values
- **example:** `color: "info"`
- `deploy-card`
- **required:** false
- **type:** boolean
- **default:** `false`
- **description:** Sends a workflow notification that is built dynamically from commit and repo info
- **example:** `deploy-card: true`
- `timezone`
- **required:** false
- **type:** string
- **default:** `"America/New_York"`
- **description:** Timezone to use for timestamps in messages
- **example:** `timezone: "Europe/Rome"`
## Example Usage
This action was built with the intention of sending workflow status notifications but also supports a simple message style
### Simple Notification
The following sends a simple notification with a title and message
```yaml
- name: Send simple notification
uses: mikesprague/teams-incoming-webhook-action@v1
with:
github-token: ${{ github.token }}
webhook-url: ${{ secrets.MS_TEAMS_WEBHOOK_URL }}
title: 'Notification Test'
message: 'This is an example of a simple notification with a title and a body'
```
### Workflow Status Notifications
The following examples show how to send notifications based on your workflow status
#### Info Notification
Include as first step in workflow to notify workflow run has started
```yaml
- name: Deploy Started Notification
uses: mikesprague/teams-incoming-webhook-action@v1
with:
github-token: ${{ github.token }}
webhook-url: ${{ secrets.MS_TEAMS_WEBHOOK_URL }}
deploy-card: true
title: 'Deployment Started'
color: 'info'
```
#### Cancel Notification
Include anywhere in steps to notify workflow run has been cancelled
```yaml
- name: Cancelled Notification
if: ${{ cancelled() }}
uses: mikesprague/teams-incoming-webhook-action@v1
with:
github-token: ${{ github.token }}
webhook-url: ${{ secrets.MS_TEAMS_WEBHOOK_URL }}
deploy-card: true
title: 'Deployment Cancelled'
color: 'warning'
```
#### Failure Notification
Include anywhere in steps to notify when a workflow run fails
```yaml
- name: Failure Notification
if: ${{ failure() }}
uses: mikesprague/teams-incoming-webhook-action@v1
with:
github-token: ${{ github.token }}
webhook-url: ${{ secrets.MS_TEAMS_WEBHOOK_URL }}
deploy-card: true
title: 'Deployment Failed'
color: 'failure'
```
#### Success Message
Include anywhere in steps to notify when workflow run is successful
```yaml
- name: Success Notification
if: ${{ success() }}
uses: mikesprague/teams-incoming-webhook-action@v1
with:
github-token: ${{ github.token }}
webhook-url: ${{ secrets.MS_TEAMS_WEBHOOK_URL }}
deploy-card: true
title: 'Deployment Successful'
color: 'success'
```
