Posts data to an endpoint on any event
Go to file
Joel Male 0740593bc2 Update build 2020-08-26 10:12:31 +10:00
.github Add node_modules until bundler is added 2020-08-26 09:57:08 +10:00
dist Update build 2020-08-26 10:12:31 +10:00
node_modules Update build 2020-08-26 10:12:31 +10:00
src Remove fetch, add axios 2020-08-26 10:10:43 +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 Convert action to ts 2020-08-26 09:36:04 +10:00
action.yml Small fixes to action.yml and action output 2020-08-26 09:50:21 +10:00
package.json Remove fetch, add axios 2020-08-26 10:10:43 +10:00
tsconfig.json Convert action to ts 2020-08-26 09:36:04 +10:00
yarn.lock Remove fetch, add axios 2020-08-26 10:10:43 +10:00

README.md

🚀 Webhook Action

GitHub Release License

A Github Action for sending data to an endpoint

Supports all workflow event types


Usage

Example:

- name: Webhook
  uses: joelwmale/webhook-action@master
  with:
    url: ${{ secrets.WEBHOOK_URL }}
    headers: "{Content-Type: 'application/json'}"
    body: "{event: 'Deployment', project: '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: https://github.com/joelwmale/webhook-action/commits/master

Arguments

Headers

Allows you to send custom headers with the request

  headers: "{Repository: 'joelwmale/webhook-action'}"

Body

Allows you to send a json payload in a string format

  body: "{event: 'Deployment', project: 'joelwmale/webhook-action'}"

Environment

The action is expecpecting a few environmental variables:

  • 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

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.