webhook-action/README.md

72 lines
1.9 KiB
Markdown
Raw Normal View History

2019-08-18 22:19:30 +00:00
# 🚀 Webhook Action
[![GitHub Release][ico-release]][link-github-release]
[![License][ico-license]](LICENSE)
A Github Action for sending a webhook event any endpoint
2019-08-18 22:19:30 +00:00
Supports all [workflow event types](https://developer.github.com/webhooks/#events)
<hr/>
## Usage
Example:
2019-08-18 22:19:30 +00:00
```yml
- name: Webhook
uses: joelwmale/webhook-action@master
with:
url: ${{ secrets.WEBHOOK_URL }}
headers: '{"repository": "joelwmale/webhook-action"}'
body: '{"event": "deployment", "repository": "joelwmale/webhook-action"}'
2019-08-18 22:19:30 +00:00
```
It is **highly** recommended to use the action is an explicit commit SHA-1:
2019-08-18 22:19:30 +00:00
`uses = "joelwmale/webhook-action@{SHA-1}"` to find a commit click [here.](https://github.com/joelwmale/webhook-action/commits/master)
2019-08-18 22:19:30 +00:00
## Action Input
The action has support for the following input variables (arguments):
2019-08-18 22:19:30 +00:00
* **`url`** (**required**): The url to send the webhook to
* **`headers`** (**optional**): Any headers you want to be sent with the webhook
* **`body`** (**optional**): The body of data send with the webhook
2019-08-18 22:19:30 +00:00
You can find more information on how to use these input variables below.
2019-08-18 22:19:30 +00:00
## Arguments
2019-08-18 22:19:30 +00:00
#### Headers
2019-08-18 22:19:30 +00:00
**Required:** false
2019-08-18 22:19:30 +00:00
Allows you to send custom headers with the request
2019-08-18 22:19:30 +00:00
```yml
headers: '{"repository": "joelwmale/webhook-action"}'
```
#### Body
**Required:** false
**Must be a stringified JSON payload**
Allows you to send a custom JSON object to the webhook
```yml
body: '{"event": "deployment", "repository": "joelwmale/webhook-action"}'
```
2019-08-18 22:19:30 +00:00
## Issues
If you find any issues or have an improvement feel free to [submit an issue](https://github.com/joelwmale/webhook-action/issues/new)
## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.
[ico-release]: https://img.shields.io/github/tag/joelwmale/webhook-action.svg
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg
[link-github-release]: https://github.com/joelwmale/webhook-action/releases