Skip to content

EVIR for developers

Add EVIR to an existing Telegram bot

Request suitable sponsored cards from your bot server, send them through Telegram, and follow the flags returned with each assignment. Use signed webhooks for later events.

  • Server-side JSON API
  • One EVIR API key
  • HMAC-signed webhooks

Core flow

Three steps in your bot server

  1. 1

    1. Save the key

    Create the key under the bot card → Connection and save it on the server as EVIR_API_KEY.

  2. 2

    2. Test the key

    Call the HTTP endpoint POST /api/v1/integrations/ping with an empty JSON body. A successful response contains data.connected: true.

  3. 3

    3. Request a card

    Call POST /api/v1/integrations/next with recipientId set to String(Telegram from.id). Omit limit for the default of 1; its allowed range is 1–10.

Open the documentation you need

Integration guide

Start here for the full request, send, and acknowledgement sequence.

Open quick start

Webhooks

Receive signed result and unsubscribe events with retries and duplicate protection.

Open webhook guide

Help

Frequently asked questions

Can I call the EVIR API from a browser?

No. Keep the EVIR API key on the server that runs your Telegram bot.

What if the assignments array is empty?

Continue the normal bot flow. An empty assignment list is a valid response, not an integration failure.

How are webhook events verified?

Verify the timestamp and HMAC signature against the raw request body, then deduplicate by event id.

Next step

Ready to integrate EVIR?

Start with the integration flow or open the full API reference.
Open API quick start