Skip to content
Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

🚀 Webhook Action

GitHub Release License Tests

A Github Action for sending a webhook event any endpoint

Supports all workflow event types


Usage

Example:

- name: Webhook
  uses: joelwmale/webhook-action@v2
  with:
    url: ${{ secrets.WEBHOOK_URL }}
    headers: '{"repository": "joelwmale/webhook-action"}'
    body: '{"event": "deployment", "repository": "joelwmale/webhook-action"}'
    github_event_payload: true

Pin to a specific version for stability:

uses: joelwmale/webhook-action@v2.4.2

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.

About

Posts data to an endpoint on any event

Resources

Stars

168 stars

Watchers

5 watching

Forks

Releases

Packages

Used by

Contributors

Languages