---
title: "Create a Pay Link Webhook"
method: POST
path: "/v1/webhook/paylink/transaction"
tags: ["Webhooks"]
---

# Create a Pay Link Webhook

`POST /v1/webhook/paylink/transaction`

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

## Query parameters

- `apiKey` string, required

## Request body

- CreatePaylinkTransactionHookDto
  - `events` 'CREATED', required — The type of event that triggers the webhook. Use 'CREATED'.
  - `paylinkId` string, required — The ID of the pay link the webhook is associated with.
  - `targetUrl` string, required — The URL that will receive the webhook payload when the event occurs.

## Response `200`

Webhook created successfully.

- PaylinkTransactionHookEntity
  - `events` 'CREATED', 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)