Tribute
English
English
  • 🔠General Information
    • About the Tribute bot
  • 🌟For content creators
    • Tribute Energy
    • LinkHub
    • Manager role
    • Physical products
      • Collections
      • Bulk Product Upload
      • FAQ
      • Preliminary Shipping Cost Calculation
    • Affiliate program
    • How to connect the bot
      • Adding bot to a channel
    • Fees, limits, currencies
    • Payouts
      • Payout balance
      • Your earnings and Settlement
      • Bank fees
      • Currencies and conversion fees
      • New requirements for payout details
    • Donations
      • Donation request
      • Regular donations
    • Goals
      • How to Create a Donation Goal
    • Subscriptions
      • How to create a subscription
      • Subscription publishing
      • Edit subscription
      • Deleting subscription
      • How to offer a discount on subscriptions
      • How to offer a subscription retention discount
    • Digital Product
      • How to Create a Digital Product
      • How to Share a Digital Product
      • How to Edit a Digital Product
      • How to Delete a Digital Product
      • How to Create a Digital Custom Product
      • How to set up web payment for digital products
    • Statistics
      • Available data
      • Where to find it
    • How to set up access to comments
      • How to set up a comment group (iOS)
      • How to set up a comment group (Android)
    • API Documentation
    • Wallet Pay
    • Telegram Stars
    • Content Restrictions
    • Promotions
      • Reduced Commission for Selling Physical Products on the “Tribute” Platform (the “Terms”)
  • 💚For subscribers
    • How to pay for a subscription
      • 🔓Payment for private channel subscription
      • 🗺️Payment for public channel subscription
    • Tribute Energy
    • How to pay for a digital product with a card
    • How to send a donation
    • Subscription management
    • Payment methods
    • Payment history
    • Cashback
  • ℹ️FAQ
Powered by GitBook
On this page
  1. For content creators

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

PreviousHow to set up a comment group (Android)NextWallet Pay

Last updated 1 day ago

🌟