---
title: "Subscribe to match events"
method: POST
path: "/api/v1/webhooks"
tags: ["webhooks"]
---

# Subscribe to match events

`POST /api/v1/webhooks`

## Request

- Base URL: `https://kicksma.sh`
- URL: `https://kicksma.sh/api/v1/webhooks`
- Auth: HTTP bearer

## Request body

- object
  - `url` string, uri, required
  - `events` string[]
  - `filter` object
    - `venueSlug` string
    - `groupCode` string
    - `codes` string[]

## Response `201`

Created; the secret is shown once

- object
  - `webhook` Webhook
    - `id` string
    - `url` string
    - `events` string[]
    - `filter` object, nullable
    - `createdAt` string
  - `secret` string
  - `signing` string

## Other responses

- `401`: Key required
- `422`: Invalid request; the message names the field
- `429`: Rate limited; the hint says how to get more room

---

[API](https://skmtc.dev/kicksma/apis/kicksmash-api.md) · [All operations](https://skmtc.dev/kicksma/apis/kicksmash-api/llms.txt) · [OpenAPI document](https://skmtc.dev/kicksma/apis/kicksmash-api/revisions/8ae952aa0f19?raw)