> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# simpleviewinc/circleci-ms-teams

Easily integrate custom MS Teams notifications into your CircleCI projects.
Create custom alert messages for any job or receive status updates.


## Commands

### status

Send a status alert at the end of a job based on success or failure.
Must be the last step in a job.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `fail_only` | boolean | false | If `true`, only send notifications on failure
 |
| `failure_message` | string | 🔴 A job has failed! | Enter custom message. |
| `success_message` | string | 🎉 A job has succeeded! | Enter custom message. |
| `webhook` | string | ${MSTEAMS_WEBHOOK} | Enter either your Webhook value or use the CircleCI UI to add your
token under the 'MSTEAMS_WEBHOOK' env var
 |

## Executors

### default

Default executor

| Parameter | Type | Default | Description |
|---|---|---|---|
| `image_tag` | string | current | Tag for the `cimg/base` Docker image. See https://circleci.com/developer/images/image/cimg/base#image-tags for further details
 |

## Examples

### example

Send a status alert at the end of a job based on success or failure.
This must be the last step in a job.


```yaml
version: '2.1'
orbs:
  circleci-ms-teams: simpleviewinc/circleci-ms-teams@1.0.0
jobs:
  build:
    docker:
      - image: <docker image>
    steps:
      - run: exit 0
      - circleci-ms-teams/status:
          fail_only: true
          webhook: WEBHOOK_URL
workflows: null
```