https://github.com/svix/svix-event-type-import-action
https://github.com/svix/svix-event-type-import-action
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/svix/svix-event-type-import-action
- Owner: svix
- License: mit
- Created: 2023-11-03T16:46:27.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-14T18:39:20.000Z (9 months ago)
- Last Synced: 2025-04-03T01:17:48.186Z (6 months ago)
- Size: 17.6 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Svix - Webhooks as a service
# Upload Event Types to Svix - GitHub Action
This GitHub action reads and uploads an OpenAPI spec (in JSON or YAML format) and uploads it to Svix to create event types for your webhooks.
For more information, check out [our docs](https://docs.svix.com/event-types#upload-openapi-specification).
## Inputs
### `openapi-file`
**Required**
Location of the OpenAPI spec file (can be in JSON or YAML format).
### `svix-api-key`
**Required**
Your [Svix API key](https://docs.svix.com/api-keys).
### `svix-api-url`
**Optional**
Override the Svix API URL. If not set, the URL will be determined using the API Key.
### `replace-all`
**Optional**
If true, archives all existing event types that are not in the OpenAPI spec. Default: `false`.
## Usage
To use this GitHub Action in your workflow, you can add the following step:
```yaml
- name: Upload Event Types to Svix
uses: svix/svix-event-type-import-action@v1.0.0
with:
openapi-file: 'path/to/your/openapi-spec.yml' # can be a .json too
svix-api-key: ${{ secrets.SVIX_API_KEY }}
```
## Documentation
For a more information, checkout our [API reference](https://docs.svix.com).