Posts data to an endpoint on any event
Go to file
2020-08-29 11:06:49 +10:00
.github v2.0.0 (#12) 2020-08-26 10:52:47 +10:00
dist Add backwards compatibility 2020-08-27 18:25:12 +10:00
node_modules Add backwards compatibility 2020-08-27 18:25:12 +10:00
src Add support for failing check on HTTP error responses (#23) 2020-08-29 11:06:49 +10:00
.eslintignore v2.0.0 (#12) 2020-08-26 10:52:47 +10:00
.eslintrc.json v2.0.0 (#12) 2020-08-26 10:52:47 +10:00
.gitignore v2.0.0 (#12) 2020-08-26 10:52:47 +10:00
.prettierignore v2.0.0 (#12) 2020-08-26 10:52:47 +10:00
.prettierrc.json v2.0.0 (#12) 2020-08-26 10:52:47 +10:00
action.yml Update action.yml 2020-08-26 10:56:36 +10:00
LICENSE 🚀 Initial commit 2019-08-19 08:19:30 +10:00
package.json v2.0.1 2020-08-27 18:23:33 +10:00
README.md v2.0.0 (#12) 2020-08-26 10:52:47 +10:00
tsconfig.json v2.0.0 (#12) 2020-08-26 10:52:47 +10:00
yarn.lock ⬆️ Bump typescript from 3.9.7 to 4.0.2 (#13) 2020-08-27 18:15:57 +10:00

🚀 Webhook Action

GitHub Release License

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 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

  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.