2017-12-16 07:29:55 -05:00
---
id: notifications
2018-02-16 13:32:53 -05:00
title: "Notifications"
2017-12-16 07:29:55 -05:00
---
Notify was built primarily to use with Slack's Incoming webhooks, but will also deliver a simple payload to any endpoint. Currently only active for `publish` / `create` commands.
## Usage
2018-05-24 06:08:15 -05:00
An example with a **HipChat** and **Google Hangouts Chat** hook:
2017-12-16 07:29:55 -05:00
#### Single notification
```yaml
notify:
method: POST
headers: [{'Content-Type': 'application/json'}]
endpoint: https://usagge.hipchat.com/v2/room/3729485/notification?auth_token=mySecretToken
content: '{"color":"green","message":"New package published: * {{ name }}* ","notify":true,"message_format":"text"}'
```
#### Multiple notification
```yaml
notify:
2018-05-24 06:08:15 -05:00
'example-google-chat':
method: POST
headers: [{'Content-Type': 'application/json'}]
endpoint: https://chat.googleapis.com/v1/spaces/AAAAB_TcJYs/messages?key=myKey& token=myToken
content: '{"text":"New package published: `{{ name }}{{#each versions}} v{{version}}{{/each}}` "}'
'example-hipchat':
2017-12-16 07:29:55 -05:00
method: POST
headers: [{'Content-Type': 'application/json'}]
endpoint: https://usagge.hipchat.com/v2/room/3729485/notification?auth_token=mySecretToken
content: '{"color":"green","message":"New package published: * {{ name }}* ","notify":true,"message_format":"text"}'
```
## Configuration
2018-01-09 03:55:16 -05:00
| Property | Type | Required | Support | Default | Description |
| ------------------- | ------------ | -------- | ------- | ------- | -------------------------------------------------------------------------------------------- |
| method | string | No | all | | HTTP verb |
| packagePattern | string | No | all | | Only run this notification if the package name matches the regular expression |
| packagePatternFlags | string | No | all | | Any flags to be used with the regular expression |
| headers | array/object | Yes | all | | If this endpoint requires specific headers, set them here as an array of key: value objects. |
| endpoint | string | Yes | all | | set the URL endpoint for this call |
2018-05-24 06:08:15 -05:00
| content | string | Yes | all | | any [handlebar ](https://handlebarsjs.com/ ) expressions |