Create or Update Lead with KickoffLabs API on New Updates (Instant) from Telegram Bot API

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

Trigger workflow on

New Updates (Instant) from the Telegram Bot API

Next, do this

Create or Update Lead with the KickoffLabs 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 Telegram Bot trigger and KickoffLabs action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Updates (Instant) trigger
1. Connect your Telegram Bot account
2. Optional- Select one or more Update Types
Configure the Create or Update Lead action
1. Connect your KickoffLabs account
2. Optional- Configure Email
3. Optional- Configure Phone Number
4. Optional- Configure IP Address
5. Optional- Configure URL
6. Optional- Configure Referrer URL
7. Optional- Configure User Agent
8. Optional- Configure Source
9. Optional- Configure Custom Fields
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 Updates (Instant) on Telegram Bot

Description:Emit new event for each new Telegram event.

Version:0.1.5

Key:telegram_bot_api-new-updates

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.

Trigger Code#

import base from "../common/webhooks.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...base,
  key: "telegram_bot_api-new-updates",
  name: "New Updates (Instant)",
  description: "Emit new event for each new Telegram event.",
  version: "0.1.5",
  type: "source",
  dedupe: "unique",
  props: {
    ...base.props,
    updateTypes: {
      propDefinition: [
        base.props.telegramBotApi,
        "updateTypes",
      ],
    },
  },
  methods: {
    ...base.methods,
    getMeta(event) {
      const {
        update_id: id,
        ...eventDetails
      } = event;
      const eventType = Object.keys(eventDetails).pop();
      const summary = `New ${eventType} update: ${id}`;
      const ts = eventDetails[eventType].edit_date ?? eventDetails[eventType].date;

      return {
        id,
        summary,
        ts,
      };
    },
    getEventTypes() {
      return this.updateTypes;
    },
    processEvent(event) {
      this.$emit(event, this.getMeta(event));
    },
  },
  sampleEmit,
};

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
Telegram Bot	`telegramBotApi`	`app`	This component uses the Telegram Bot app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Update Types	`updateTypes`	`string[]`	Select a value from the drop down menu:`{ "label": "Message", "value": "message" }{ "label": "Edited Message", "value": "edited_message" }{ "label": "Channel Post", "value": "channel_post" }{ "label": "Edited Channel Post", "value": "edited_channel_post" }{ "label": "Inline Query", "value": "inline_query" }{ "label": "Chosen Inline Result", "value": "chosen_inline_result" }{ "label": "Callback Query", "value": "callback_query" }{ "label": "Shipping Query", "value": "shipping_query" }{ "label": "Pre Checkout Query", "value": "pre_checkout_query" }{ "label": "Poll", "value": "poll" }{ "label": "Poll Answer", "value": "poll_answer" }{ "label": "My Chat Member", "value": "my_chat_member" }{ "label": "Chat Member", "value": "chat_member" }{ "label": "Chat Join Request", "value": "chat_join_request" }`

Trigger 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.

About Telegram Bot#

Telegram, is a cloud-based, cross-platform, encrypted instant messaging (IM) service.

Action#

Create or Update Lead on KickoffLabs

Description:Adds a new lead or modifies an existing lead on your campaign. [See the documentation](https://dev.kickofflabs.com/create/).

Version:0.0.1

Key:kickofflabs-create-or-update-lead

View on GitHub

KickoffLabs Overview#

The KickoffLabs API enables you to automate your referral marketing campaigns by integrating with their service. With this API, you can programmatically manage campaigns, leads, and rewards, allowing you to dynamically respond to new sign-ups or reward achievements. By connecting the KickoffLabs API to Pipedream, you can create powerful workflows that react to events in real-time, synchronize data across multiple services, or even trigger custom logic tailored to your marketing strategy.

Action Code#

import app from "../../kickofflabs.app.mjs";

export default {
  name: "Create or Update Lead",
  description: "Adds a new lead or modifies an existing lead on your campaign. [See the documentation](https://dev.kickofflabs.com/create/).",
  key: "kickofflabs-create-or-update-lead",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    email: {
      type: "string",
      label: "Email",
      description: "Email address of the lead.",
      optional: true,
    },
    phoneNumber: {
      type: "string",
      label: "Phone Number",
      description: "Phone number of the lead.",
      optional: true,
    },
    ip: {
      type: "string",
      label: "IP Address",
      description: "By default, we use the IP address of the request. This is great if your are using ajax to make the request. However, if you are making the request on the server, you may want to include user’s ip address.",
      optional: true,
    },
    url: {
      type: "string",
      label: "URL",
      description: "The URL which the lead signed up on.",
      optional: true,
    },
    ref: {
      type: "string",
      label: "Referrer URL",
      description: "The referrer url the lead came from.",
      optional: true,
    },
    userAgent: {
      type: "string",
      label: "User Agent",
      description: "The user agent of the lead.",
      optional: true,
    },
    source: {
      type: "string",
      label: "Source",
      description: "This will default to API, but you can change it to something unique. This is helpful if you are sending leads in from various sources. In additional, if source is API, we will not perform duplicate IP address checks.",
      optional: true,
    },
    customFields: {
      type: "object",
      label: "Custom Fields",
      description: "Any additional parameters you include when signing up a lead will be captured as custom fields.",
      optional: true,
    },
  },
  async run({ $ }) {
    const res = await this.app.createOrUpdateLead({
      email: this.email,
      phone_number: this.phoneNumber,
      ip: this.ip,
      __url: this.url,
      __ref: this.ref,
      __user_agent: this.userAgent,
      __source: this.source,
    }, $);
    $.export("summary", `Successfully created or updated lead with id ${res.id}`);
    return res;
  },
};

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
KickoffLabs	`app`	`app`	This component uses the KickoffLabs app.
Email	`email`	`string`	Email address of the lead.
Phone Number	`phoneNumber`	`string`	Phone number of the lead.
IP Address	`ip`	`string`	By default, we use the IP address of the request. This is great if your are using ajax to make the request. However, if you are making the request on the server, you may want to include user’s ip address.
URL	`url`	`string`	The URL which the lead signed up on.
Referrer URL	`ref`	`string`	The referrer url the lead came from.
User Agent	`userAgent`	`string`	The user agent of the lead.
Source	`source`	`string`	This will default to API, but you can change it to something unique. This is helpful if you are sending leads in from various sources. In additional, if source is API, we will not perform duplicate IP address checks.
Custom Fields	`customFields`	`object`	Any additional parameters you include when signing up a lead will be captured as custom fields.

Action Authentication#

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

To retrieve your Campaign ID and API Key,