Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 1.33 KB

README.md

File metadata and controls

48 lines (33 loc) · 1.33 KB

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.

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.

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:

- 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.