Posts data to an endpoint on any event
Go to file
Joel Male 6b83612926 🚀 Initial commit 2019-08-19 08:19:30 +10:00
Dockerfile 🚀 Initial commit 2019-08-19 08:19:30 +10:00
LICENSE 🚀 Initial commit 2019-08-19 08:19:30 +10:00
README.md 🚀 Initial commit 2019-08-19 08:19:30 +10:00
entrypoint.sh 🚀 Initial commit 2019-08-19 08:19:30 +10:00

README.md

🚀 Webhook Action

GitHub Release License

A Github Action for sending data to an endpoint

Supports all workflow event types


Usage

Sending a string:

- name: Webhook
  uses: joelwmale/webhook-action@master
  env:
    WEBHOOK_URL: ${{ secrets.WEBHOOK_URL }}
  with:
    data: "Hello from github actions!"

Sending a body of data:

- name: Webhook
  uses: joelwmale/webhook-action@master
  env:
    WEBHOOK_URL: ${{ secrets.WEBHOOK_URL }}
  with:
    data: "{'deployment': 'finished', 'project': 'actions'}"

It is highly recommended to use the action is an explicit commit SHA-1:

uses = "joelwmale/webhook-action@master@{SHA-1}" to find a commit click here: https://github.com/joelwmale/webhook-action/commits/master

Arguments

  • data: "Hello from github actions!"
    
  • data: "{'deployment': 'finished', 'project': 'actions'}"
    

Environment

The action is expecting a single environment variable of your data. This can be pre-encoded json string, or just a message. Format it to how your API is expecting.

  • WEBHOOK_URL (required): This is the webhook url to send the payload to.

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.