mirror of
https://github.com/joelwmale/webhook-action.git
synced 2024-11-29 02:45:23 +01:00
Posts data to an endpoint on any event
a35a18a4c5
Bump @types/node from 16.3.3 to 16.4.0 |
||
---|---|---|
.github | ||
dist | ||
node_modules | ||
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 a webhook event any endpoint
Supports all workflow event types
Usage
Example:
- name: Webhook
uses: joelwmale/webhook-action@master
with:
url: ${{ secrets.WEBHOOK_URL }}
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.
Action Input
The action has support for the following input variables (arguments):
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 webhookinsecure
(optional): Enables calling to known self-signed or invalid SSL certificates
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
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
body: '{"event": "deployment", "repository": "joelwmale/webhook-action"}'
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.