Send a Document/Image with Telegram Bot API on New Streams By Game from Twitch API

Pipedream makes it easy to connect APIs for Telegram Bot, Twitch and 2,400+ other apps remarkably fast.

Trigger workflow on

New Streams By Game from the Twitch API

Next, do this

Send a Document/Image with the Telegram Bot API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Twitch trigger and Telegram Bot action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Streams By Game trigger
1. Connect your Twitch account
2. Configure timer
3. Configure Game Title
4. Configure Stream Language
5. Configure Max Items
Configure the Send a Document/Image action
1. Connect your Telegram Bot account
2. Configure Chat ID
3. Optional- Configure Caption
4. Optional- Configure File Name
5. Configure Document or Image
6. Optional- Select a Parse Mode
7. Optional- Select a Content Type
8. Optional- Configure Disable Notifications
9. Optional- Configure Original Message ID
10. Optional- Configure Reply Markup
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Streams By Game on Twitch

Description:Emit new event when a live stream starts from any stream matching the game and language specified.

Version:0.1.2

Key:twitch-streams-by-game

View on GitHub

Twitch Overview#

The Twitch API unlocks a world of possibilities for engaging with live streaming communities and understanding audience behaviors. With Pipedream, you can harness this API to automate many aspects of Twitch interaction and analysis. From tracking stream stats to automating chat messages, the Twitch API lets you create workflows that interact with Twitch's vast live streaming ecosystem. Pipedream's serverless platform streamlines these tasks, making it simple to connect Twitch with other services for enhanced functionalities.

Trigger Code#

import common from "../common-polling.mjs";
import twitch from "../../twitch.app.mjs";

export default {
  ...common,
  name: "New Streams By Game",
  key: "twitch-streams-by-game",
  description: "Emit new event when a live stream starts from any stream matching the game and language specified.",
  version: "0.1.2",
  type: "source",
  props: {
    ...common.props,
    game: {
      propDefinition: [
        twitch,
        "game",
      ],
    },
    language: {
      propDefinition: [
        twitch,
        "language",
      ],
    },
    max: {
      propDefinition: [
        twitch,
        "max",
      ],
    },
  },
  methods: {
    ...common.methods,
    getMeta({
      id,
      title: summary,
      started_at: startedAt,
    }) {
      const ts = new Date(startedAt).getTime();
      return {
        id: `${id}${ts}`,
        summary,
        ts,
      };
    },
  },
  async run() {
    const { data: gameData } = await this.twitch.getGames([
      this.game,
    ]);
    if (gameData.length == 0) {
      console.log(`No game found with the name ${this.game}`);
      return;
    }

    // get and emit streams for the specified game & language
    const streams = await this.paginate(
      this.twitch.getStreams.bind(this),
      {
        game_id: gameData[0].id,
        language: this.language,
      },
      this.max,
    );
    for await (const stream of streams) {
      this.$emit(stream, this.getMeta(stream));
    }
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Twitch	`twitch`	`app`	This component uses the Twitch app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Game Title	`game`	`string`	Watch for live streams about the specified game.
Stream Language	`language`	`string`	Watch for games streamed in the specified language. A language value must be either the ISO 639-1 two-letter code for a supported stream language or "other".
Max Items	`max`	`integer`	The maximum number of items to return at one time. Streams are returned sorted by number of viewers, in descending order. Videos and Clips are returned sorted by publish date.

Trigger Authentication#

Twitch uses OAuth authentication. When you connect your Twitch account, Pipedream will open a popup window where you can sign into Twitch and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Twitch API.

Pipedream requests the following authorization scopes when you connect your account:

analytics:read:extensionsanalytics:read:gamesbits:readchannel:read:subscriptionsclips:edituser:edituser:edit:broadcastuser:read:broadcastuser:read:emailuser:read:followsuser:read:blocked_usersuser:manage:blocked_usersmoderator:read:followerschannel:read:editorschannel:manage:videosuser:read:subscriptions

About Twitch#

Twitch is an interactive livestreaming service for content spanning gaming, entertainment, sports, music, and more.

Action#

Send a Document/Image on Telegram Bot

Description:Sends a document or an image to your Telegram Desktop application. [See the docs](https://core.telegram.org/bots/api#senddocument) for more information

Version:0.0.6

Key:telegram_bot_api-send-document-or-image

View on GitHub

Telegram Bot Overview#

The Telegram Bot API allows you to build bots that can interact with users on the Telegram platform. Using Pipedream, you can automate messaging, handle commands, and trigger actions based on conversations or alerts. Pipedream's serverless execution model enables you to create complex workflows involving Telegram messages without managing any infrastructure. With Pipedream's integration, you can process inbound messages, send outbound notifications, and connect the Telegram Bot API with numerous other services to create powerful automation solutions.

Action Code#

import telegramBotApi from "../../telegram_bot_api.app.mjs";
import contentTypes from "../../common/content-types.mjs";

export default {
  key: "telegram_bot_api-send-document-or-image",
  name: "Send a Document/Image",
  description: "Sends a document or an image to your Telegram Desktop application. [See the docs](https://core.telegram.org/bots/api#senddocument) for more information",
  version: "0.0.6",
  type: "action",
  props: {
    telegramBotApi,
    chatId: {
      propDefinition: [
        telegramBotApi,
        "chatId",
      ],
    },
    caption: {
      propDefinition: [
        telegramBotApi,
        "caption",
      ],
      description: "Enter the file caption.",
    },
    filename: {
      propDefinition: [
        telegramBotApi,
        "filename",
      ],
    },
    doc: {
      propDefinition: [
        telegramBotApi,
        "media",
      ],
      label: "Document or Image",
    },
    parse_mode: {
      propDefinition: [
        telegramBotApi,
        "parse_mode",
      ],
    },
    contentType: {
      propDefinition: [
        telegramBotApi,
        "contentType",
      ],
      options: contentTypes.all,
    },
    disable_notification: {
      propDefinition: [
        telegramBotApi,
        "disable_notification",
      ],
    },
    reply_to_message_id: {
      propDefinition: [
        telegramBotApi,
        "reply_to_message_id",
      ],
    },
    reply_markup: {
      propDefinition: [
        telegramBotApi,
        "reply_markup",
      ],
    },
  },
  async run({ $ }) {
    const resp = await this.telegramBotApi.sendDocument(this.chatId, this.doc, {
      caption: this.caption,
      parse_mode: this.parse_mode,
      disable_notification: this.disable_notification,
      reply_to_message_id: this.reply_to_message_id,
      reply_markup: this.reply_markup,
      filename: this.filename,
      contentType: this.contentType,
    });
    $.export("$summary", `Successfully sent the document "${resp.document?.file_name}" to chat, "${this.chatId}"`);
    return resp;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Telegram Bot	`telegramBotApi`	`app`	This component uses the Telegram Bot app.
Chat ID	`chatId`	`string`	Enter the unique identifier for the target chat (e.g. `1035597319`) or username of the target public chat (in the format `@channelusername` or `@supergroupusername`). For example, if the group's public link is `t.me/mygroup`, the username is `@mygroup`.
Caption	`caption`	`string`	Enter the file caption.
File Name	`filename`	`string`	Enter a filename.
Document or Image	`doc`	`string`	File to send. Pass a file_id to send a file that exists on the Telegram servers, pass an HTTP URL for Telegram to get a file from the Internet, or pass the path to the file (e.g., `/tmp/myFile.ext`) to upload a new one using a file downloaded to `/tmp`. File must meet Telegram's requirements for MIME type and size.
Parse Mode	`parse_mode`	`string`	Select a value from the drop down menu:`MarkdownV2HTMLMarkdown`
Content Type	`contentType`	`string`	Select a value from the drop down menu:`{ "label": "Plain Text", "value": "text/plain" }{ "label": "HTML Data", "value": "text/html" }{ "label": "XML Files", "value": "application/xml" }{ "label": "PDF Files", "value": "application/pdf" }{ "label": "Gif Images", "value": "image/gif" }{ "label": "JPG Images", "value": "image/jpeg" }{ "label": "PNG Images", "value": "image/png" }{ "label": "Bitmap Images", "value": "image/bmp" }{ "label": "Vector Images", "value": "image/svg+xml" }{ "label": "Video - MPEG", "value": "video/mpeg" }{ "label": "Video - MP4", "value": "video/mp4" }{ "label": "Video - WebM", "value": "video/webm" }{ "label": "Video - OGG", "value": "video/ogg" }{ "label": "Audio - MPEG", "value": "audio/mpeg" }{ "label": "Audio - Midi", "value": "audio/mid" }{ "label": "Audio - WebM", "value": "audio/webm" }{ "label": "Audio - OGG", "value": "audio/ogg" }{ "label": "Audio - Wave", "value": "audio/vnd.wav" }`
Disable Notifications	`disable_notification`	`boolean`	Choose if to send the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound.
Original Message ID	`reply_to_message_id`	`string`	Enter the ID of the original message.
Reply Markup	`reply_markup`	`string`	Enter additional interface options that are a JSON-serialized object including an inline keyboard, a custom reply keyboard, instructions to remove the reply keyboard or instructions to force a reply from the user, e.g. `{"inline_keyboard":[[{"text":"Some button text 2","url":"https://botpress.org"}]]}` or `{"keyboard":[["Yes","No"],["Maybe"]]}`. Note: keyboard cannot be used with channels. See the docs for more information.

Action Authentication#

Telegram Bot uses API keys for authentication. When you connect your Telegram Bot account, Pipedream securely stores the keys so you can easily authenticate to Telegram Bot APIs in both code and no-code steps.

To use the Telegram Bot API, you must first create a new bot by chatting with the BotFather.

After you create your bot, copy the bot token and add it below.

Send a Document/Image with Telegram Bot API on New Streams By Game from Twitch API

Pipedream makes it easy to connect APIs for Telegram Bot, Twitch and 2,400+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular