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.

Required
Location of the OpenAPI spec file (can be in JSON or YAML format).

Required
Your Svix API key.

Optional Override the Svix API URL. If not set, the URL will be determined using the API Key.

Optional If true, archives all existing event types that are not in the OpenAPI spec. Default: false.

To use this GitHub Action in your workflow, you can add the following step:

- name: Upload Event Types to Svix
  uses: svix/[email protected]
  with:
    openapi-file: 'path/to/your/openapi-spec.yml' # can be a .json too
    svix-api-key: ${{ secrets.SVIX_API_KEY }}

For a more information, checkout our API reference.