Posts data to an endpoint on any event
Find a file
dependabot[bot] a9ae78c91a
build(deps): bump undici from 5.28.3 to 5.28.4
Bumps [undici](https://github.com/nodejs/undici) from 5.28.3 to 5.28.4.
- [Release notes](https://github.com/nodejs/undici/releases)
- [Commits](https://github.com/nodejs/undici/compare/v5.28.3...v5.28.4)

---
updated-dependencies:
- dependency-name: undici
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-04-04 17:40:53 +00:00
.github chore: update tests 2024-03-28 12:02:50 +10:00
__tests__ chore: updating deps 2024-03-28 12:25:32 +10:00
dist feat: v2.4.1 build 2024-03-31 22:31:07 +10:00
src feature: fix post step 2024-03-31 22:29:19 +10:00
.eslintignore chore: updating deps 2024-03-28 12:25:32 +10:00
.eslintrc.json feat: finish updates & adding github event support 2024-03-28 13:00:21 +10:00
.gitignore chore: project cleanup 2024-03-28 12:33:51 +10:00
.prettierignore v2.0.0 (#12) 2020-08-26 10:52:47 +10:00
.prettierrc.json Convert action to ts 2020-08-26 09:36:04 +10:00
action.yml feature: fix post step 2024-03-31 22:29:19 +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 build(deps): bump undici from 5.28.3 to 5.28.4 2024-04-04 17:40:53 +00:00
package.json v2.4.1 2024-03-31 22:30:28 +10:00
README.md feat: finish updates & adding github event support 2024-03-28 13:00:21 +10:00
tsconfig.json chore: fixing errors 2024-03-28 12:43:14 +10:00
yarn.lock build(deps): bump undici from 5.28.3 to 5.28.4 2024-04-04 17:40:53 +00: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_payload: true

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

You can find more information on how to use these input variables below.

Arguments

URL

Required: true

The URL to send the webhook to

  url: ${{ secrets.WEBHOOK_URL }}

or

  url: https://webhook.site/8b1b1b1b-8b1b-8b1b-8b1b-8b1b1b1b1b1b

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"}'

Insecure

Required: false Default: false

Allows you to send a webhook to a known self-signed or invalid SSL certificate

  insecure: true

Github Event Payload

Required: false Default: false

Allows you to send the Github event payload to your webhook

The payload will be sent as a JSON object under the key githubEventPayload on the root of the payload sent to your webhook

  github_event_payload: true

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.