actions/webhook-action
1
0
Fork 0
mirror of https://github.com/joelwmale/webhook-action.git synced 2024-08-25 08:08:00 +00:00
Code Issues Packages Projects Releases Wiki Activity
Posts data to an endpoint on any event
6 Commits 4 Branches 12 Tags 89 MiB
TypeScript 95.4%
JavaScript 4.6%
1cbd7b0bbc
Go to file
Joel Male 1cbd7b0bbc Add node-fetch
2020-08-26 10:00:45 +10:00
.github Add node_modules until bundler is added 2020-08-26 09:57:08 +10:00
dist Add node_modules until bundler is added 2020-08-26 09:57:08 +10:00
node_modules Add node-fetch 2020-08-26 10:00:45 +10:00
src Add node-fetch 2020-08-26 10:00:45 +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 Small fixes to action.yml and action output 2020-08-26 09:50:21 +10:00
LICENSE 🚀 Initial commit 2019-08-19 08:19:30 +10:00
package.json Add node-fetch 2020-08-26 10:00:45 +10:00
README.md Convert action to ts 2020-08-26 09:36:04 +10:00
tsconfig.json Convert action to ts 2020-08-26 09:36:04 +10:00
yarn.lock Add node-fetch 2020-08-26 10:00:45 +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.