actions/webhook-action
1
0
Fork 0
mirror of https://github.com/joelwmale/webhook-action.git synced 2026-08-31 14:39:48 +08:00
Code Issues Packages Projects Releases Wiki Activity

v2.0.0

Browse Source
This commit is contained in:
Joel Male
2020-08-26 10:50:05 +10:00
parent d3ff660fa9
commit a2d3f9a4da
6 changed files with 33 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+31 -24
View File
@@ -3,7 +3,7 @@
[![GitHub Release][ico-release]][link-github-release]
[![License][ico-license]](LICENSE)
A Github Action for sending data to an endpoint
A Github Action for sending a webhook event any endpoint
Supports all [workflow event types](https://developer.github.com/webhooks/#events)
@@ -18,40 +18,47 @@ Example:
uses: joelwmale/webhook-action@master
with:
url: ${{ secrets.WEBHOOK_URL }}
headers: "{Content-Type: 'application/json'}"
body: "{event: 'Deployment', project: 'joelwmale/webhook-action'}"
headers: '{"repository": "joelwmale/webhook-action"}'
body: '{"event": "deployment", "repository": "joelwmale/webhook-action"}'
```
It is **highly** recommended to use the action is an explicit commit SHA-1:
`uses = "joelwmale/webhook-action@{SHA-1}"` to find a commit click here: https://github.com/joelwmale/webhook-action/commits/master
`uses = "joelwmale/webhook-action@{SHA-1}"` to find a commit click [here.](https://github.com/joelwmale/webhook-action/commits/master)
### Arguments
## Action Input
### Headers
Allows you to send custom headers with the request
```yml
headers: "{Repository: 'joelwmale/webhook-action'}"
```
### Body
Allows you to send a json payload in a string format
```yml
body: "{event: 'Deployment', project: 'joelwmale/webhook-action'}"
```
### Environment
The action is expecpecting a few environmental variables:
The action has support for the following input variables (arguments):
* **`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
You can find more information on how to use these input variables below.
## Arguments
#### Headers
**Required:** false
Allows you to send custom headers with the request
```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"}'
```
## Issues
If you find any issues or have an improvement feel free to [submit an issue](https://github.com/joelwmale/webhook-action/issues/new)