Subscribe Webhook Endpoint with AutoConfig - GitHub Action

This GitHub action configures a webhook endpoint using Webhooks AutoConfig.

AutoConfig lets you declare your endpoint configuration in code, so it's always in sync with your code, without any manual changes in the webhooks management UI.

For more information, check out the docs.

Inputs

autoconfig-token

Required Your AutoConfig token from the webhooks management portal (auto_v1_...).

endpoint

Required A JSON object describing the endpoint configuration (EndpointIn).

Supported fields include url, filterTypes, description, disabled, channels, headers, metadata, uid, version, and throttleRate.

Example:

{
  "url": "https://api.us.example.com/webhooks/acme",
  "filterTypes": ["invoice.paid", "user.created"]
}

Outputs

endpoint

The configured endpoint (EndpointOut) as a JSON string.

Usage

Before using this action, create an endpoint using AutoConfig and copy the token from the webhooks management portal:

Add the following step to your CI/CD pipeline:

- name: Subscribe Webhook Endpoint with AutoConfig
  uses: svix/webhooks-autoconfig-action@v1.0.0
  with:
    autoconfig-token: ${{ secrets.AUTO_CONFIG_TOKEN }}
    endpoint: |
      {
        "url": "https://api.us.example.com/webhooks/acme",
        "filterTypes": ["invoice.paid", "user.created"]
      }

Documentation

• Webhooks AutoConfig guide
• Svix documentation