Create Call with Hyros API on New Commit from GitHub API

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

Trigger workflow on

New Commit from the GitHub API

Next, do this

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

Select this integration
Configure the New Commit trigger
1. Configure eventTypeInfo
2. Connect your GitHub account
3. Select a Repository
4. Select a Branch
Configure the Create Call action
1. Connect your Hyros account
2. Configure Name
3. Optional- Configure Email
4. Optional- Configure First Name
5. Optional- Configure Last Name
6. Optional- Configure Lead IPs
7. Optional- Configure Phone Numbers
8. Optional- Configure Id
9. Optional- Configure Date
10. Optional- Configure Qualified
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 Commit on GitHub

Description:Emit new event when commits are pushed to a branch

Version:1.0.8

Key:github-new-commit

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-commit",
  name: "New Commit",
  description: "Emit new event when commits are pushed to a branch",
  version: "1.0.8",
  type: "source",
  dedupe: "unique",
  props: {
    eventTypeInfo: {
      type: "alert",
      alertType: "info",
      content: "**Note:** one event is emitted for each individual commit, even if they are received at the same time.",
    },
    ...common.props,
    branch: {
      propDefinition: [
        common.props.github,
        "branch",
        (c) => ({
          repoFullname: c.repoFullname,
        }),
      ],
    },
  },
  methods: {
    ...common.methods,
    _getLastTimestamp() {
      return this.db.get("lastTimestamp") ?? Date.now();
    },
    _setLastTimestamp(value) {
      this.db.set("lastTimestamp", value);
    },
    getSampleTimerEvent,
    getSampleWebhookEvent,
    getWebhookEvents() {
      return [
        "push",
      ];
    },
    getSummary(item) {
      return `New commit: ${item.commit?.message ?? item.message}`;
    },
    async onWebhookTrigger(event) {
      const {
        body, headers,
      } = event;
      if (body?.ref?.split?.("refs/heads/").pop() === this.branch.split("/").pop()) {
        body.commits.forEach((commit) => {
          const { id } = commit;
          this.emitEvent({
            id,
            headers,
            item: commit,
          });
        });
      }
    },
    async onTimerTrigger() {
      const { repoFullname } = this;
      const timestamp = this._getLastTimestamp();
      const since = new Date(timestamp).toISOString()
        .slice(0, -5) + "Z";
      const sha = this.branch.split("/").pop();
      const items = await this.github.getCommits({
        repoFullname,
        sha,
        since,
      });

      const savedItems = this._getSavedItems();
      const shouldEmit = this.shouldEmit();

      items
        .filter(({ sha }) => !savedItems.includes(sha))
        .sort((a, b) => {
          const dateA = new Date(a.commit.author.date);
          const dateB = new Date(b.commit.author.date);
          return dateA - dateB;
        })
        .forEach((item) => {
          const id = item.sha;
          if (shouldEmit) {
            this.emitEvent({
              id,
              item,
            });
          }
          savedItems.push(id);
        });

      this._setSavedItems(savedItems);
      this._setLastTimestamp(Date.now());
    },
    getHttpDocsLink() {
      return "https://docs.github.com/en/webhooks/webhook-events-and-payloads#push";
    },
    getTimerDocsLink() {
      return "https://docs.github.com/en/rest/commits/commits?apiVersion=2022-11-28#list-commits";
    },
  },
};

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.
Branch	`branch`	`string`	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 Call on Hyros

Description:Create a new call. [See the documentation](https://hyros.docs.apiary.io/#reference/0/calls/create)

Version:0.0.1

Key:hyros-create-call

View on GitHub

Hyros Overview#

The Hyros API offers the ability to track and analyze customer interactions across various marketing channels, aiming to improve ad tracking and ROI. Integrated within Pipedream, it allows for the automation of data collection, real-time analytics, and operational workflows. By leveraging Pipedream's serverless platform, developers can create workflows that respond to events from Hyros, trigger actions based on data insights, or synchronize data with other apps seamlessly.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import hyros from "../../hyros.app.mjs";

export default {
  key: "hyros-create-call",
  name: "Create Call",
  version: "0.0.1",
  description: "Create a new call. [See the documentation](https://hyros.docs.apiary.io/#reference/0/calls/create)",
  type: "action",
  props: {
    hyros,
    name: {
      type: "string",
      label: "Name",
      description: "The name of the call.",
    },
    email: {
      propDefinition: [
        hyros,
        "email",
      ],
      description: "Email associated with the lead that made the call.",
      optional: true,
    },
    firstName: {
      propDefinition: [
        hyros,
        "firstName",
      ],
      description: "First name of the lead that made the call.",
      optional: true,
    },
    lastName: {
      propDefinition: [
        hyros,
        "lastName",
      ],
      description: "Last name of the lead that made the call.",
      optional: true,
    },
    leadIps: {
      propDefinition: [
        hyros,
        "leadIps",
      ],
      description: "IPs of the customer that made the call. Will be used on the Ad attributing process.",
      optional: true,
    },
    phoneNumbers: {
      propDefinition: [
        hyros,
        "phoneNumbers",
      ],
      description: "Phone numbers of the lead that made the call. Will be used on the Ad attributing process.",
      optional: true,
    },
    id: {
      type: "string",
      label: "Id",
      description: "Identifier by which the call will be grouped. A default id will be assigned if it is not included.",
      optional: true,
    },
    date: {
      type: "string",
      label: "Date",
      description: "Date on which the transaction was processed. The date must be written in accordance with [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). Format: YYYY-MM-DDThh:mm:ss",
      optional: true,
    },
    qualified: {
      type: "boolean",
      label: "Qualified",
      description: "A flag that indicates if the call should be marked as unqualified. If it's not present the call is created as qualified.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      hyros,
      ...data
    } = this;

    let response;
    try {
      response = await hyros.createCall({
        $,
        data,
      });
    } catch ({ response }) {
      throw new ConfigurationError(response.data.message[0]);
    }

    $.export("$summary", `A new call with Id: ${response.request_id} was successfully created!`);
    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
Hyros	`hyros`	`app`	This component uses the Hyros app.
Name	`name`	`string`	The name of the call.
Email	`email`	`string`	Email associated with the lead that made the call.
First Name	`firstName`	`string`	First name of the lead that made the call.
Last Name	`lastName`	`string`	Last name of the lead that made the call.
Lead IPs	`leadIps`	`string[]`	IPs of the customer that made the call. Will be used on the Ad attributing process.
Phone Numbers	`phoneNumbers`	`string[]`	Phone numbers of the lead that made the call. Will be used on the Ad attributing process.
Id	`id`	`string`	Identifier by which the call will be grouped. A default id will be assigned if it is not included.
Date	`date`	`string`	Date on which the transaction was processed. The date must be written in accordance with ISO 8601. Format: YYYY-MM-DDThh:mm:ss
Qualified	`qualified`	`boolean`	A flag that indicates if the call should be marked as unqualified. If it's not present the call is created as qualified.

Create Call with Hyros API on New Commit from GitHub API

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