---
title: "Subscribe a URL to signing events"
method: POST
path: "/v1/webhooks"
tags: ["Webhooks"]
---

# Subscribe a URL to signing events

`POST /v1/webhooks`

## Request

- Base URL: `https://sign-api.tvarka.pro`
- URL: `https://sign-api.tvarka.pro/v1/webhooks`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`
  - OAuth 2 (authorization code, authorization URL `https://sign-api.tvarka.pro/oauth/authorize`, token URL `https://sign-api.tvarka.pro/oauth/token`, scopes: `sign.read`, `sign.signings`)

Delivers the chosen events of every signing this integration
creates to `url` (the `subscriptionEvent` webhook below). This is
what Zapier, Make and Power Automate call when a user turns a
trigger on. The same URL again replaces its event list and returns
the same subscription, so a retried subscribe never doubles
deliveries. `url` is checked like `webhookUrl`: public HTTPS, at
most 500 characters, redirects never followed. An integration holds
at most 50 subscriptions (v1.12.0).

## Request body

- CreateWebhookSubscription
  - `url` string, uri, required
  - `events` WebhookEventName[], required

## Response `201`

Subscribed.

- WebhookSubscription
  - `webhookId` string, uuid, required
  - `url` string, uri, required
  - `events` WebhookEventName[], required
  - `createdAt` string, date-time, required

## Other responses

- `400`: An RFC 9457 problem document.
- `401`: An RFC 9457 problem document.
- `402`: An RFC 9457 problem document.
- `403`: An RFC 9457 problem document.
- `409`: The integration already holds 50 subscriptions.
- `429`: An RFC 9457 problem document.
- `503`: An RFC 9457 problem document.

---

[API](https://skmtc.dev/tvarka/apis/tvarka-sign-api.md) · [All operations](https://skmtc.dev/tvarka/apis/tvarka-sign-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tvarka/apis/tvarka-sign-api/revisions/e3fdd995c013?raw)