Create or Update Lead with KickoffLabs API on New Card in Column (Classic Projects) from GitHub API

Pipedream makes it easy to connect APIs for KickoffLabs, GitHub and 2,200+ other apps remarkably fast.

Trigger workflow on

New Card in Column (Classic Projects) from the GitHub 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 GitHub 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 Card in Column (Classic Projects) trigger
1. Connect your GitHub account
2. Select a Repository
3. Select a Project
4. Select a Column
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 Card in Column (Classic Projects) on GitHub

Description:Emit new event when a (classic) project card is created or moved to a specific column. For Projects V2 use `New Issue with Status` trigger. [More information here](https://docs.github.com/en/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board)

Version:1.0.6

Key:github-new-card-in-column

View on GitHub

GitHub Overview#

The GitHub API is a powerful gateway to interaction with GitHub's vast web of data and services, offering a suite of endpoints to manipulate and retrieve information on repositories, pull requests, issues, and more. Harnessing this API on Pipedream, you can orchestrate automated workflows that respond to events in real-time, manage repository data, streamline collaborative processes, and connect GitHub with other services for a more integrated development lifecycle.

Trigger Code#

import common from "../common/common-webhook.mjs";
import constants from "../common/constants.mjs";
import { getRelevantHeaders } from "../common/utils.mjs";

export default {
  ...common,
  key: "github-new-card-in-column",
  name: "New Card in Column (Classic Projects)",
  description: "Emit new event when a (classic) project card is created or moved to a specific column. For Projects V2 use `New Issue with Status` trigger. [More information here](https://docs.github.com/en/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board)",
  version: "1.0.6",
  type: "source",
  props: {
    ...common.props,
    project: {
      propDefinition: [
        common.props.github,
        "project",
        (c) => ({
          repoFullname: c.repoFullname,
        }),
      ],
    },
    column: {
      propDefinition: [
        common.props.github,
        "column",
        (c) => ({
          project: c.project,
        }),
      ],
      withLabel: true,
    },
  },
  methods: {
    ...common.methods,
    getWebhookEvents() {
      return [
        "project_card",
      ];
    },
    getThisColumnLabel() {
      if (typeof this.column ===  "object") {
        return this.column.label;
      }
      return this.column;
    },
    getThisColumnValue() {
      if (typeof this.column ===  "object") {
        return this.column.value;
      }
      return this.column;
    },
    isCardInThisColumn(card) {
      const { column_id: columnId } = card;
      return columnId === this.getThisColumnValue();
    },
    generateMeta(card) {
      return {
        id: card.id,
        summary: `New card in ${this.getThisColumnLabel()}: ${card.note}`,
        ts: Date.parse(card.updated_at),
      };
    },
    async loadHistoricalEvents() {
      const cards = await this.github.getProjectCards({
        columnId: this.getThisColumnValue(),
        per_page: constants.HISTORICAL_EVENTS,
      });
      for (const card of cards) {
        await this.processCard({
          card,
        });
      }
    },
    async processCard({
      card, headers = {},
    }) {
      const meta = this.generateMeta(card);
      const issue = await this.github.getIssueFromProjectCard({
        repoFullname: this.repoFullname,
        cardId: card.id,
      });
      this.$emit({
        card,
        issue,
        ...getRelevantHeaders(headers),
      }, meta);
    },
  },
  async run(event) {
    const {
      headers, body: { project_card: card },
    } = event;
    if (!card) {
      console.log("No card in event. Skipping event.");
      return;
    }

    if (!this.isCardInThisColumn(card)) {
      console.log(`Card not in ${this.getThisColumnLabel()}. Skipping...`);
      return;
    }

    await this.processCard({
      card,
      headers,
    });
  },
};

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
GitHub	`github`	`app`	This component uses the GitHub app.
Repository	`repoFullname`	`string`	Select a value from the drop down menu.
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.
Project	`project`	`integer`	Select a value from the drop down menu.
Column	`column`	`integer`	Select a value from the drop down menu.

Trigger Authentication#

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

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

repoadmin:orgadmin:public_keyadmin:org_hookgistprojectnotificationsuserwrite:discussionwrite:packagesread:packagesadmin:repo_hook

About GitHub#

Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.

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,

Navigate to your KickoffLabs account and sign in
Click on one of your campaigns (or hit “View Campaign” on campaign)

Once you are in a campaign, navigate to "Settings" >> "All Settings"

Save your Campaign ID and API Key from this page.

Create or Update Lead with KickoffLabs API on New Card in Column (Classic Projects) from GitHub API

Pipedream makes it easy to connect APIs for KickoffLabs, GitHub and 2,200+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,200+apps by most popular

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