Web Request Action

Easily make a web request from a workflow using Axios. Supports all methods, uploading files, basic authentication and more.

To get started, create or update your workflow file.

Workflow

Add the step to an existing workflow or create a new one.

Existing Workflow

- name: "Web Request"
  uses: cssnr/web-request-action@v1
  with:
    url: https://httpbin.org/post
    method: "POST"
    data: '{"key": "value"}' # JSON or YAML
    headers: |
      key: value
    params: { "parameter": "value" }
    username: ${{ secrets.USERNAME }}
    password: ${{ secrets.PASSWORD }}
    insecure: false
    file: path/to/file.txt
    name: file

New Workflow

name: "Web Request Action"

on:
  push:

jobs:
  deploy:
    name: "Deploy"
    runs-on: ubuntu-latest
    timeout-minutes: 5

    steps:
      - name: "Web Request"
        uses: cssnr/web-request-action@v1
        with:
          url: ${{ secrets.RENDER_HOOK }}
          params: |
            ref: ${{ github.ref_name }}

Hash Copied to Clipboard

Check out the Rolling Tags for more tag options.

See the Inputs Documentation for additional options and default values.

Features

• Provide data in JSON or YAML format.
• Supports files with custom file keys.
• Add Basic Auth and ignore SSL warnings.

Don't see your feature here? Please help by submitting a Feature Request.

Rolling Tags

The following rolling tags are maintained to improve stability across updates.

Version Tag	Rolling	Bugs	Feat.	Name	Target	Example
	✅	✅	✅	Major	vN.x.x	vN
	✅	✅	❌	Minor	vN.N.x	vN.N
	❌	❌	❌	Micro	vN.N.N	vN.N.N

You can view the release notes for each version on the releases page.

The Major tag is recommended. It is the most up-to-date and always backwards compatible. Breaking changes would result in a Major version bump. At a minimum you should use a Minor tag.

Tags Security Notice

As shown above, tags are mutable; however, commit hashes are not. Therefore, if security is your top priority, you should pin your actions to a specific commit hash.

• GitHub Documentation
• Article by StepSecurity

 

WARNING

These docs are not finished. Please see the README.md on GitHub.