mirror of
https://github.com/dkershner6/post-api-call-action.git
synced 2024-11-15 11:23:52 +08:00
A GitHub action to make a POST call to any API
.github | ||
.projen | ||
dist | ||
docs | ||
src | ||
.eslintrc.json | ||
.gitattributes | ||
.gitignore | ||
.mergify.yml | ||
.npmignore | ||
.npmrc | ||
.prettierignore | ||
.prettierrc.json | ||
.projenrc.ts | ||
action.yml | ||
LICENSE | ||
package.json | ||
pnpm-lock.yaml | ||
README.md | ||
tsconfig.json | ||
tsconfig.publish.json |
webhook-action
GitHub Action that sends a POST request of any kind. This is a thin wrapper around Axios.post.
Inputs
url
Required: URL to send post request to.
data
Optional: JSON string of data to pass into request. Default "{}"
.
headers
Optional: JSON string of headers to pass into request. Default "{}"
.
params
Optional: JSON string of query parameters to pass into request. Default "{}"
.
Example usage
uses: dkershner6/post-api-call-action@v2
with:
url: ${{ secrets.API_URL }}
data: "{\"command\": \"publish\"}"
headers: "{\"Authorization\": \"Bearer ${{ secrets.API_KEY }}\"}"
params: "{\"content\": \"Test Content\"}"
Contributing
All contributions are welcome, please open an issue or pull request.
To use this repository:
npm i -g pnpm
(if don't have pnpm installed)pnpm i
npx projen
(this will ensure everything is setup correctly, and you can run this command at any time)- Good to make your changes!
- You can run
npx projen build
at any time to build the project.