Posts data to an endpoint on any event
Go to file
2024-03-28 12:02:50 +10:00
__tests__ feature: additional tests 2022-11-10 23:15:52 +10:00
.github chore: update tests 2024-03-28 12:02:50 +10:00
dist feat: updates & github event support 2024-03-28 12:00:41 +10:00
node_modules feat: updates & github event support 2024-03-28 12:00:41 +10:00
src feat: updates & github event support 2024-03-28 12:00:41 +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
action.yml feat: updates & github event support 2024-03-28 12:00:41 +10:00
babel.config.js feature: tests 2022-11-10 23:06:47 +10:00
jest.config.js feature: tests 2022-11-10 23:06:47 +10:00
LICENSE 🚀 Initial commit 2019-08-19 08:19:30 +10:00
package-lock.json feat: updates & github event support 2024-03-28 12:00:41 +10:00
package.json feat: updates & github event support 2024-03-28 12:00:41 +10:00
README.md feat: updates & github event support 2024-03-28 12:00:41 +10:00
tsconfig.json wip 2022-11-10 22:40:17 +10:00
yarn.lock feat: updates & github event support 2024-03-28 12:00:41 +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"}'
    github_event: ${{ toJson(github.event) }}

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
  • github_event (optional): Enables forwarding the Github event to your 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.