Create Activity with Orbit API on New Collaborator from GitHub API

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

Trigger workflow on

New Collaborator from the GitHub API

Next, do this

Create Activity with the Orbit API

No credit card required

▶

Watch us build a workflow

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

Select this integration
Configure the New Collaborator trigger
1. Connect your GitHub account
2. Select a Repository
Configure the Create Activity action
1. Connect your Orbit account
2. Select a Workspace Slug
3. Select a Workspace Member Slug
4. Configure Title
5. Optional- Configure Description
6. Optional- Configure Link
7. Optional- Configure Link Text
8. Optional- Configure Weight
9. Optional- Configure Activity Type Key
10. Optional- Configure Occurred At
11. Optional- Configure Properties
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 Collaborator on GitHub

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

Version:1.0.2

Key:github-new-collaborator

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

export default {
  ...common,
  key: "github-new-collaborator",
  name: "New Collaborator",
  description: `Emit new event when a collaborator is added [See the documentation](${DOCS_LINK})`,
  version: "1.0.2",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getSampleTimerEvent,
    getSampleWebhookEvent,
    getWebhookEvents() {
      return [
        "member",
      ];
    },
    shouldEmitWebhookEvent(body) {
      return body?.action === "added";
    },
    getWebhookEventItem(body) {
      return body.member;
    },
    getSummary(item) {
      return `New collaborator: ${item.login}`;
    },
    getPollingData(args) {
      return this.github.getRepositoryLatestCollaborators(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 Activity on Orbit

Description:Create a new activity. [See the docs here](https://api.orbit.love/reference/post_workspace-slug-members-member-slug-activities)

Version:0.0.1

Key:orbit-create-activity

View on GitHub

Orbit Overview#

The Orbit API enables you to monitor and manage the uptime and performance of your websites and internet services. Through automation and integration on Pipedream, you can streamline incident management, aggregate performance data, and enhance communication across your tech stack. By leveraging real-time data from Orbit, you can trigger workflows based on site status changes, get aggregated insights, and automate responses to performance issues.

Action Code#

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

export default {
  name: "Create Activity",
  description: "Create a new activity. [See the docs here](https://api.orbit.love/reference/post_workspace-slug-members-member-slug-activities)",
  key: "orbit-create-activity",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    workspaceSlug: {
      propDefinition: [
        app,
        "workspaceSlug",
      ],
    },
    workspaceMemberSlug: {
      propDefinition: [
        app,
        "workspaceMemberSlug",
        ({ workspaceSlug }) => ({
          workspaceSlug,
        }),
      ],
    },
    title: {
      type: "string",
      label: "Title",
      description: "A title for the activity; displayed in the timeline",
    },
    description: {
      type: "string",
      label: "Description",
      description: "A description for the activity; displayed in the timeline",
      optional: true,
    },
    link: {
      type: "string",
      label: "Link",
      description: "A URL for the activity; displayed in the timeline",
      optional: true,
    },
    linkText: {
      type: "string",
      label: "Link Text",
      description: "The text for the timeline link",
      optional: true,
    },
    weight: {
      type: "integer",
      label: "Weight",
      description: "A custom weight to be used in filters and reports; defaults to 1.",
      optional: true,
    },
    activityTypeKey: {
      type: "string",
      label: "Activity Type Key",
      description: "The key for a custom activity type for the workspace. Will create a new activity type if it does not exist.",
      optional: true,
    },
    occurredAt: {
      type: "string",
      label: "Occurred At",
      description: "The date and time the activity occurred; defaults to now.",
      optional: true,
    },
    properties: {
      type: "object",
      label: "Properties",
      description: "Key-value pairs to provide contextual metadata about an activity.",
      optional: true,
    },
  },
  async run({ $ }) {
    const activity = {
      title: this.title,
      description: this.description,
      link: this.link,
      link_text: this.linkText,
      weight: this.weight,
      activity_type_key: this.activityTypeKey,
      occurred_at: this.occurredAt,
      properties: this.properties,
    };
    const res = await this.app.createActivity(
      this.workspaceSlug,
      this.workspaceMemberSlug,
      activity,
    );
    $.export("$summary", `Activity successfully created with id "${res.data.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
Orbit	`app`	`app`	This component uses the Orbit app.
Workspace Slug	`workspaceSlug`	`string`	Select a value from the drop down menu.
Workspace Member Slug	`workspaceMemberSlug`	`string`	Select a value from the drop down menu.
Title	`title`	`string`	A title for the activity; displayed in the timeline
Description	`description`	`string`	A description for the activity; displayed in the timeline
Link	`link`	`string`	A URL for the activity; displayed in the timeline
Link Text	`linkText`	`string`	The text for the timeline link
Weight	`weight`	`integer`	A custom weight to be used in filters and reports; defaults to 1.
Activity Type Key	`activityTypeKey`	`string`	The key for a custom activity type for the workspace. Will create a new activity type if it does not exist.
Occurred At	`occurredAt`	`string`	The date and time the activity occurred; defaults to now.
Properties	`properties`	`object`	Key-value pairs to provide contextual metadata about an activity.

Create Activity with Orbit API on New Collaborator from GitHub API

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