Create an Invite with Envoy API on New Branch from GitHub API

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

Trigger workflow on

New Branch from the GitHub API

Next, do this

Create an Invite with the Envoy API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a GitHub trigger and Envoy 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 trigger
1. Connect your GitHub account
2. Select a Repository
Configure the Create an Invite action
1. Connect your Envoy account
2. Configure Arrival date
3. Select a Location
4. Configure Name
5. Optional- Configure Email
6. Optional- Select a Host
7. Optional- Configure Departure date
8. Optional- Configure Private notes
9. Optional- Configure Send email to invitee
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 on GitHub

Description:Emit new event when a branch is created [See the documentation](https://docs.github.com/en/webhooks/webhook-events-and-payloads#create)

Version:1.0.1

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";

const DOCS_LINK =
  "https://docs.github.com/en/webhooks/webhook-events-and-payloads#create";

export default {
  ...common,
  key: "github-new-branch",
  name: "New Branch",
  description: `Emit new event when a branch is created [See the documentation](${DOCS_LINK})`,
  version: "1.0.1",
  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);
    },
  },
};

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 an Invite on Envoy

Description:Create an Invite to a person to visit a location. [See the docs](https://developers.envoy.com/hub/reference/createinvite).

Version:0.0.1

Key:envoy-create-an-invite

View on GitHub

Envoy Overview#

The Envoy API empowers users to streamline workplace operations, particularly visitor management, deliveries, and room bookings. Leveraging Pipedream's capabilities, you can automate tasks involving these aspects. For example, you can receive notifications when guests arrive, sync visitor data with other systems, or automate the creation and management of room bookings.

Action Code#

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

export default {
  key: "envoy-create-an-invite",
  name: "Create an Invite",
  description: "Create an Invite to a person to visit a location. [See the docs](https://developers.envoy.com/hub/reference/createinvite).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    expectedArrivalAt: {
      propDefinition: [
        app,
        "expectedArrivalAt",
      ],
    },
    locationId: {
      propDefinition: [
        app,
        "locationId",
      ],
    },
    name: {
      propDefinition: [
        app,
        "visitorName",
      ],
    },
    email: {
      propDefinition: [
        app,
        "visitorEmail",
      ],
    },
    hostEmployeeId: {
      propDefinition: [
        app,
        "employeeId",
      ],
      description: "Unique identifier of a host.",
    },
    expectedDepartureAt: {
      propDefinition: [
        app,
        "expectedDepartureAt",
      ],
    },
    notes: {
      propDefinition: [
        app,
        "notes",
      ],
    },
    sendEmailToInvitee: {
      propDefinition: [
        app,
        "sendEmailToInvitee",
      ],
    },
  },
  async run({ $ }) {
    const data = {
      invite: {
        expectedArrivalAt: this.expectedArrivalAt,
        expectedDepartureAt: this.expectedDepartureAt,
        locationId: this.locationId,
        notes: this.notes,
        sendEmailToInvitee: this.sendEmailToInvitee,
        hostEmployeeId: this.hostEmployeeId,
        invitee: {
          name: this.name,
          email: this.email,
        },
      },
    };
    const response = await this.app.createInvite($, data);
    $.export("$summary", `Successfully created an invite with id: "${response.data.id}"`);
    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
Envoy	`app`	`app`	This component uses the Envoy app.
Arrival date	`expectedArrivalAt`	`string`	A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
Location	`locationId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	Visitor full name.
Email	`email`	`string`	Visitor email address.
Host	`hostEmployeeId`	`string`	Select a value from the drop down menu.
Departure date	`expectedDepartureAt`	`string`	A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
Private notes	`notes`	`string`	Enter your private notes.
Send email to invitee	`sendEmailToInvitee`	`boolean`	Either it should or not send email to invitee

Action Authentication#

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

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

locations.readcompanies.reademployees.readtoken.refreshinvites.readentries.readinvites.write

Create an Invite with Envoy API on New Branch from GitHub API

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

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

Developers ♥ Pipedream

1-24of2,000+apps by most popular

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