🕸️Веб-хуки

Получайте нотификации на ваш URL о событиях по проекту.

Чтобы настроить, перейдите в Настройки проекта в раздел Веб-хуки.

После того как вы укажете ссылку для получения нотификаций, вы сможете отправить тестовые запросы, которые помогут вам в настройке на своей стороне.

Передаваемые параметры

На ваш URL отправляются запросы со следующими параметрами:

Параметр	Тип	Описание
clickid	string	ID перехода. Если его нет, то передается пустое значение.
paymentId	string	ID платежа. Передается для событий с типами firstbill, rebill, refund. Если его нет, то передается пустое значение.
type	string	Тип события. Может быть trial, firstbill, rebill, refund, cancel or update.
plan	int	ID тарифа.
planName	string	Название тарифа.
planPrice	string	Сумма оплаты в копейках или центах.
planCurrency	string	Валюта тарифа. Может быть RUB, USD или EUR.
planPeriod	string	Период оплаты тарифа. Может быть 1 month, 3 months, 6 months, 1 year, One-time. Для старых тарифов возможны 1 day, 3 days, 1 week, 2 weeks, 2 months.
trialPeriod	string	Срок пробного периода тарифа. Может быть 3 days, 7 days, 10 days, 14 days, 30 days.
nextPayment	string	Расчетная дата следующего платежа по подписке. Если даты нет, то передается пустое значение.
kickAt	string	Расчетная дата до которой оплачена подписка. Если даты нет, то передается пустое значение.
subscription	string	ID подписки.
consumer	int	ID пользователя. Если его нет, то передается пустое значение.
consumerEmail	string	Email пользователя. Если его нет, то передается пустое значение.
consumerTelegramId	string	Telegram ID пользователя. Если его нет, то передается пустое значение.
txid	string	Hash события.

Типы событий

1. trial - новая подписка с пробным периодом.

2. firstbill - новая подписка.

3. update - обновление данных о подписке (отправляется когда нам становится известен consumerTelegramId после перехода пользователя в бота).

4. rebill - продление подписки.

5. cancel - отмена подписки.

6. refund- возврат платежа.

clickId

Вы можете самостоятельно размечать подписки с помощью параметра clickId. Для этого добавьте к платежной ссылке вашего проекта ?clickId=[значение]

Пример: https://paywall.pw/sampleproject?clickId=123456

Значение не может превышать 34 символа и должно состоять из цифр и латинских букв.

Если пользователь перейдет по ссылке с параметром и совершит подписку, то у его подписки сохранится значение clickId. При отправке запроса на ваш URL (см. раздел проекта "Веб-хуки") это значение будет передаваться с остальными сведениями о подписке.

Генерируйте уникальные значения для каждого перехода. Это может пригодиться при реализации собственной партнерской (реферальной) программы.

Отправка запросов

Первый запрос отправляется сразу. Если не был получен ответ с кодом 2хх, то вторая попытка будет через 30 секунд. Последующие попытки происходят через N*2 времени. Максимальный срок отправки уведомлений - одна неделя.

Для тестирования отлично подойдет бесплатный инструмент webhook.site