Create Participant with Viral Loops API on New Branch Created from GitHub API

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

Trigger workflow on

New Branch Created from the GitHub API

Next, do this

Create Participant with the Viral Loops 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 Viral Loops action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Branch Created trigger
1. Connect your GitHub account
2. Select a Repository
Configure the Create Participant action
1. Connect your Viral Loops account
2. Configure First name
3. Configure Last name
4. Configure Email
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 Branch Created on GitHub

Description:Emit new event when a branch is created.

Version:1.0.5

Key:github-new-branch

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-flex.mjs";
import {
  getSampleTimerEvent, getSampleWebhookEvent,
} from "./common-sample-events.mjs";

export default {
  ...common,
  key: "github-new-branch",
  name: "New Branch Created",
  description: "Emit new event when a branch is created.",
  version: "1.0.5",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getSampleTimerEvent,
    getSampleWebhookEvent,
    getWebhookEvents() {
      return [
        "create",
      ];
    },
    shouldEmitWebhookEvent(body) {
      return body?.ref_type === "branch";
    },
    getId(item) {
      return item.ref ?? item.name;
    },
    getSummary(item) {
      return `New branch: ${this.getId(item)}`;
    },
    getPollingData(args) {
      return this.github.getBranches(args);
    },
    getHttpDocsLink() {
      return "https://docs.github.com/en/webhooks/webhook-events-and-payloads#create";
    },
    getTimerDocsLink() {
      return "https://docs.github.com/en/rest/branches/branches?apiVersion=2022-11-28#list-branches";
    },
  },
};

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.

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 Participant on Viral Loops

Description:Creates a participant. [See documentation here](https://developers.viral-loops.com/reference/post_campaign-participant-1)

Version:0.0.1

Key:viral_loops-create-participant

View on GitHub

Viral Loops Overview#

The Viral Loops API enables you to tap into the potent capabilities of referral marketing within your applications. Using this API through Pipedream, you can automate campaign management, participant tracking, and reward allocation. You can also trigger actions based on referral achievements or new participant sign-ups, making it simpler to manage marketing campaigns and analyze their performance in real-time.

Action Code#

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

export default {
  name: "Create Participant",
  version: "0.0.1",
  key: "viral_loops-create-participant",
  description: "Creates a participant. [See documentation here](https://developers.viral-loops.com/reference/post_campaign-participant-1)",
  type: "action",
  props: {
    app,
    firstName: {
      type: "string",
      label: "First name",
      description: "The first name of the participant",
    },
    lastName: {
      type: "string",
      label: "Last name",
      description: "The last name of the participant",
    },
    email: {
      type: "string",
      label: "Email",
      description: "The email of the participant",
    },
  },
  async run({ $ }) {
    const response = await this.app.createParticipant({
      $,
      data: {
        user: {
          email: this.email,
          firstname: this.firstName,
          lasttname: this.lastName,
        },
      },
    });

    if (response) {
      $.export("$summary", `Successfully created participant with referral code \`${response.referralCode}\``);
    }

    return response;
  },
};

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
Viral Loops	`app`	`app`	This component uses the Viral Loops app.
First name	`firstName`	`string`	The first name of the participant
Last name	`lastName`	`string`	The last name of the participant
Email	`email`	`string`	The email of the participant

Action Authentication#

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

To retrieve your API Token,

Navigate to your Viral Loops account and sign in
Click “Edit” on one of your Campaigns
Click “Next” several times to get to the “Installation”

Create Participant with Viral Loops API on New Branch Created from GitHub API

Pipedream makes it easy to connect APIs for Viral Loops, 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