Telegram

This guide describes how to add and configure Telegram integration.

Telegram

Apphud’s integration with Telegram service allows you to receive real-time alerts about subscription events and other in-app activity directly in your Telegram channel. This is especially useful for keeping your team informed on the early state of app growth about important changes like trial conversions, renewals, cancellations, and billing issues without logging into the dashboard.

Available Telegram integration settings give you the flexibility to:

  • Set up multiple Telegram integrations using the same platform (iOS, Android or Web) as the source, each with unique rules and filters
  • Route different types of events to different Telegram topics within the same channel, e.g., split Production and Sandbox events, or monitor billing errors and trials separately.
  • Create separate notification streams for different team needs by setting up granular filters on various parameter groups, like monitoring events only for the latest app version.

📘

Note

Telegram's API enforces rate limits that can result in message delivery failures during high-frequency events, such as promotional campaigns generating numerous events in a short period for a single channel. In such cases only a portion of events may reach Telegram, while others will be dropped due to Telegram API throttling (error 429: Too Many Requests).

Before a planned campaigns with large volumes of zero-price purchases or similar bursts, consider temporarily disabling those specific event notifications (by applying filter by product for instance), to maintain stability for other alerts sent to the same channel.

Before You Begin

If you'd like to get notifications in a dedicated place, rather than in a bot, make sure you set up:

  • A Telegram channel or chat
  • If needed, one or more Topics (a.k.a. threads) created within the channel, so that notifications can be separated by logic you define (e.g. billing errors vs trial starts).

Once they are in place, you’ll be ready to create flexible, multi-stream alerting systems for your app directly in Telegram.

How to Add Integration?

Step 1 - Choose the source

At Apphud go to "Connections" menu, choose "Integrations" tab and add Telegram:

In the opened Source pop-up, choose a platform.

Then specify a connection Name on the integration setting page.

Step 2 - Specify the channel

To get notifications directly in ApphudBot:

Click on Launch Apphud Bot button or find @ApphudBot in Telegram app.

In Telegram, prompt the bot to start. The bot will show the message with the chat ID you need to use:

"Please follow the documentation if you want to add a Telegram integration to your app in Apphud. UseXXXXXXXXXX value as the Chat ID."

To get notifications in your dedicated Channel or Chat:

Alternatively, you can add the Apphud bot to a chat, group, or channel (with or without topics) to receive notifications there. Simply call /start@Apphudbot command in the channel.

If you start the bot in a channel topic, the message will be:

"Please follow the documentation if you want to add a Telegram integration to your app in Apphud. UseXXXXXXXXXX value as the Chat ID. If you want to receive messages in this specific topic, use XXXXX value as Topic ID. If Topic ID is not provided, messages will be sent to the general topic."

Copy the Chat ID (and Topic ID, if needed) from the message to the Telegram integration settings in Apphud.

Step 3 - Configure Environments

Specify if you'd like to receive notifications about Production and Sendbox events by putting checkmarks in the respective fields.

You can set up the same or different channels (topics) for Production and Sandbox events.

Step 4 - Choose Events

Go through the Events configuration section to see if you'd like to get some additional events beyond those chosen by default, or deactivate the default ones. Make sure to check all the event groups located on different tabs.

You can use a toggle to include or exclude an event.

Step 5 - Apply Filters

You can add filters to the integration connection to better tailor the delivery of events:

  1. Click on "+Where" button
  2. Select filter group (you can check the list of available filters here)
  3. Select parameter
  4. Specify a condition. Beware that each parameter has a different default one.
  5. Choose a parameter value
  6. Click on "Apply"

Step 6 - Save the Integration

Once all the settings are configured, click the Save button in the upper right corner.

The integration will now appear alongside other configured ones in the Connections list.

Step 7 - Test the Integration

Once the integration is saved, we recommend testing the integration before enabling it.

Step 8 - Enable the Integration

Use the Enable integration toggle to activate or deactivate a Telegram integration from either its settings page or the Connections list.

Events

This is a table of all possible events that are being sent to Telegram.

📘

Note

You can get more details regarding events here.

EventDefault Name
TRIAL PERIOD
Trial period startedTrial Started
Successful conversion from trial period to regular subscriptionTrial Converted
Failed conversion from trial period to regular subscriptionTrial Expired
INTRODUCTORY OFFER
Introductory offer startedIntro Started
Introductory offer renewedIntro Renewed
Successful conversion from introductory offer to regular subscriptionIntro Converted
Failed conversion from introductory offer to regular subscription or failed renewIntro Expired
Refund during introductory offerIntro Refunded
REGULAR SUBSCRIPTION
Subscription startedSubscription Started
Subscription renewedSubscription Renewed
Subscription expiredSubscription Expired
Subscription refundedSubscription Refunded
PROMOTIONAL OFFER
Promotional offer startedPromo Started
Promotional offer renewedPromo Renewed
Successful conversion from promotional offer to regular subscriptionPromo Converted
Failed conversion from promotional offer to regular subscription or failed renewPromo Expired
Refund during promotional offerPromo Refunded
CANCELLATIONS
Trial CanceledTrial Canceled
Subscription CanceledSubscription Canceled
Autorenew disabled (Deprecated)Autorenew Disabled
Autorenew enabledAutorenew Enabled
OTHER EVENTS
Non renewing purchaseNon Renewing Purchase
Non renewing purchase refundedNon Renewing Purchase Refunded
Billing IssueBilling Issue

Send Test Event

To test the integration work:

  1. Click on the Test button in the upper right corner of the integration Settings page.
  2. Enter an Event ID or Transaction ID (to find these in the Events list, ensure to adjust the layout and include the fields)
  3. Click Send now and analyze the results shown.

You can also test a configured Telegram integration by finding it in the Connections list, clicking "…" and then in the dropdown choosing Send test event:

2452

From this menu, you can also Remove the integration, or navigate to its settings page by choosing Configure menu item.