mirror of https://github.com/joelwmale/webhook-action.git synced 2024-11-28 18:35:21 +01:00

Posts data to an endpoint on any event

Find a file

dependabot[bot] 3fba134ccf build(deps): bump node-fetch from 3.2.10 to 3.3.2 Bumps [node-fetch](https://github.com/node-fetch/node-fetch) from 3.2.10 to 3.3.2. - [Release notes](https://github.com/node-fetch/node-fetch/releases) - [Commits](https://github.com/node-fetch/node-fetch/compare/v3.2.10...v3.3.2) --- updated-dependencies: - dependency-name: node-fetch dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>		2023-07-31 11:58:03 +00:00
.github	feature: tests	2022-11-10 23:10:05 +10:00
__tests__	feature: additional tests	2022-11-10 23:15:52 +10:00
dist	feature: tests	2022-11-10 23:06:47 +10:00
node_modules	feature: tests	2022-11-10 23:06:47 +10:00
src	feature: tests	2022-11-10 23:06:47 +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	wip	2022-11-10 22:22:24 +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.json	build(deps): bump node-fetch from 3.2.10 to 3.3.2	2023-07-31 11:58:03 +00:00
README.md	add ability to call self-signed or invalid certificate clients	2021-02-26 13:58:33 +10:00
tsconfig.json	wip	2022-11-10 22:40:17 +10:00
yarn.lock	build(deps): bump node-fetch from 3.2.10 to 3.3.2	2023-07-31 11:58:03 +00:00

README.md

🚀 Webhook Action

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.