mirror of
https://github.com/joelwmale/webhook-action.git
synced 2024-08-25 08:08:00 +00:00
Posts data to an endpoint on any event
00f958821e
- Add optional header support - Add optional body support |
||
---|---|---|
dist | ||
src | ||
.eslintignore | ||
.eslintrc.json | ||
.gitignore | ||
.prettierignore | ||
.prettierrc.json | ||
action.yml | ||
LICENSE | ||
package.json | ||
README.md | ||
tsconfig.json | ||
yarn.lock |
🚀 Webhook Action
A Github Action for sending data to an endpoint
Supports all workflow event types
Usage
Example:
- name: Webhook
uses: joelwmale/webhook-action@master
with:
url: ${{ secrets.WEBHOOK_URL }}
headers: "{Content-Type: 'application/json'}"
body: "{event: 'Deployment', project: '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
Arguments
Headers
Allows you to send custom headers with the request
headers: "{Repository: 'joelwmale/webhook-action'}"
Body
Allows you to send a json payload in a string format
body: "{event: 'Deployment', project: 'joelwmale/webhook-action'}"
Environment
The action is expecpecting a few environmental variables:
url
(required): The url to send the webhook toheaders
(optional): Any headers you want to be sent with the webhookbody
(optional): The body of data send with the webhook
Issues
If you find any issues or have an improvement feel free to submit an issue
License
The MIT License (MIT). Please see License File for more information.