API Documentation

We have added API keys for access to the public API and for data integration with external systems.

How to find this feature:

1. Go to the Creator Dashboard in the Tribute mini-app.

2. Click the three-dot icon in the top right corner and select Settings.

3. Open the API Keys section.

---

How Webhooks Work:

We send a request with the event payload to the user upon specific events.

Currently, there are two webhooks:

• NewSubscriptionEvent – triggered when a subscription is purchased

• CancelledSubscriptionEvent – triggered when a subscription is cancelled

Note: There is currently no webhook for subscription renewal.

---

Verifying Request Signatures:

1. Take the raw body of the incoming request.

2. Sign it using your API key with the same method.

3. Compare the resulting signature to the trbt-signature header.

If the signatures match, the request is authentic.

---

Response Examples:

{ created_at: "2025-03-20T01:15:58.33246Z", name: "new_subscription", payload: { subscription_name: "Support my art 🌟", subscription_id: 1644, period_id: 1547, period: "monthly", price: 1000, amount: 700, currency: "eur", user_id: 31326, telegram_user_id: 12321321, channel_id: 614, channel_name: "lbs", expires_at: "2025-04-20T01:15:57.305733Z", }, sent_at: "2025-03-20T01:15:58.542279448Z", }

{ created_at: "2025-03-21T11:20:44.013969Z", name: "cancelled_subscription", payload: { subscription_name: "Join the private club 🎉", subscription_id: 1646, period_id: 1549, period: "monthly", price: 1000, amount: 1000, currency: "eur", user_id: 31326, telegram_user_id: 12321321, channel_id: 614, channel_name: "lbs", cancel_reason: "", expires_at: "2025-03-20T11:13:44.737Z", }, sent_at: "2025-03-21T11:20:44.527657077Z", }

NewSubscriptionEvent

Field	Type	JSON Key
SubscriptionName	string	subscription_name
SubscriptionID	uint	subscription_id
PeriodID	uint	period_id
Period	string	period
Price	int64	price
Amount	int64	amount
Currency	string	currency
UserID	uint	user_id
TelegramUserID	uint	telegram_user_id
ChannelID	uint	channel_id
ChannelName	string	channel_name
ExpiresAt	time	expires_at

---

CancelledSubscriptionEvent

Field	Type	JSON Key
SubscriptionName	string	subscription_name
SubscriptionID	uint	subscription_id
PeriodID	uint	period_id
Period	string	period
Price	int64	price
Amount	int64	amount
Currency	string	currency
UserID	uint	user_id
TelegramUserID	uint	telegram_user_id
ChannelID	uint	channel_id
ChannelName	string	channel_name
CancelReason	string	cancel_reason
ExpiresAt	time	expires_at