---
title: "Create a Subscription Webhook"
method: POST
path: "/v1/webhook/paylink/subscription"
tags: ["Webhooks"]
---

# Create a Subscription Webhook

`POST /v1/webhook/paylink/subscription`

Create a webhook to listen for transaction events on a subscription pay link.

## Query parameters

- `apiKey` string, required

## Request body

- CreatePaylinkSubscriptionHookDto
  - `events` string[], required — List of subscription lifecycle events that will trigger the webhook. Supported values are 'STARTED', 'RENEWED', and 'ENDED'.
  - `paylinkId` string, required — The ID of the pay link associated with the subscription.
  - `targetUrl` string, required — The URL that will receive webhook notifications for subscription events.

## Response `200`

Webhook creation response

- PaylinkSubscriptionHookEntity[]
  - `events` string[], required
  - `id` string, required
  - `paylink` string, required
  - `company` string, required
  - `targetUrl` string, required
  - `sharedToken` string, required
  - `creator` string

## Other responses

- `401` — Provided API key has no access to the resource.

---

[API](https://skmtc.net/hel/apis/helio-open-api.md) · [All operations](https://skmtc.net/hel/apis/helio-open-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hel/helio-open-api/revisions/5732beb2d39f/schema)