Posts data to an endpoint on any event
Go to file
mergify[bot] 3ddc916e81
Merge pull request #508 from joelwmale/dependabot/npm_and_yarn/types/node-18.6.1
Bump @types/node from 18.0.6 to 18.6.1
2022-07-25 11:16:11 +00:00
.github Fixes invalid mergify config 2020-09-17 18:47:31 +10:00
dist v2.1.0 2021-02-26 14:00:44 +10:00
node_modules v2.1.0 2021-02-26 14:00:44 +10:00
src v2.1.0 2021-02-26 14:00:44 +10:00
.eslintignore Convert action to ts 2020-08-26 09:36:04 +10:00
.eslintrc.json Convert action to ts 2020-08-26 09:36:04 +10:00
.gitignore Add node_modules until bundler is added 2020-08-26 09:57:08 +10:00
.prettierignore Convert action to ts 2020-08-26 09:36:04 +10:00
.prettierrc.json Convert action to ts 2020-08-26 09:36:04 +10:00
LICENSE 🚀 Initial commit 2019-08-19 08:19:30 +10:00
README.md add ability to call self-signed or invalid certificate clients 2021-02-26 13:58:33 +10:00
action.yml add ability to call self-signed or invalid certificate clients 2021-02-26 13:58:33 +10:00
package.json Bump @types/node from 18.0.6 to 18.6.1 2022-07-25 11:15:38 +00:00
tsconfig.json Convert action to ts 2020-08-26 09:36:04 +10:00
yarn.lock Bump @types/node from 18.0.6 to 18.6.1 2022-07-25 11:15:38 +00: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
  • insecure (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.