Posts data to an endpoint on any event
Go to file
Joel Male 752932350b Add mergify 2020-09-17 16:40:53 +10:00
.github Add mergify 2020-09-17 16:40:53 +10:00
dist v2.0.2 2020-08-29 11:10:10 +10:00
node_modules Merge master -> develop 2020-08-29 11:13:52 +10:00
src v2.0.2 2020-08-29 11:10:10 +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
LICENSE 🚀 Initial commit 2019-08-19 08:19:30 +10:00
README.md 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
package.json Bump @types/node from 14.6.0 to 14.6.1 (#21) 2020-08-29 11:10:25 +10:00
tsconfig.json v2.0.0 (#12) 2020-08-26 10:52:47 +10:00
yarn.lock Bump @types/node from 14.6.0 to 14.6.1 (#21) 2020-08-29 11:10:25 +10:00

README.md

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