Create Event with UserSketch API on New Commit Comment from GitHub API

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

Trigger workflow on

New Commit Comment from the GitHub API

Next, do this

Create Event with the UserSketch 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 UserSketch 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 Comment trigger
1. Configure eventTypeInfo
2. Connect your GitHub account
3. Select a Repository
Configure the Create Event action
1. Connect your UserSketch account
2. Configure Email
3. Select a Event type
4. Optional- Configure Date
5. Configure Link
6. Configure Message
7. Configure Subject
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 Comment on GitHub

Description:Emit new event when a commit comment is created

Version:1.0.7

Key:github-new-commit-comment

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-comment",
  name: "New Commit Comment",
  description: "Emit new event when a commit comment is created",
  version: "1.0.7",
  type: "source",
  dedupe: "unique",
  props: {
    eventTypeInfo: {
      type: "alert",
      alertType: "info",
      content: "**Note:** commit comments are not the same as pull request comments. [See the GitHub documentation](https://docs.github.com/en/rest/guides/working-with-comments?apiVersion=2022-11-28) for more information.",
    },
    ...common.props,
  },
  methods: {
    ...common.methods,
    getSampleTimerEvent,
    getSampleWebhookEvent,
    getWebhookEvents() {
      return [
        "commit_comment",
      ];
    },
    shouldEmitWebhookEvent(body) {
      return body?.action === "created";
    },
    getWebhookEventItem(body) {
      return body.comment;
    },
    getSummary(item) {
      return `New comment (${item.id})`;
    },
    getPollingData(args) {
      return this.github.getRepositoryLatestCommitComments(args);
    },
    getHttpDocsLink() {
      return "https://docs.github.com/en/webhooks/webhook-events-and-payloads#commit_comment";
    },
    getTimerDocsLink() {
      return "https://docs.github.com/en/rest/commits/comments?apiVersion=2022-11-28#list-commit-comments-for-a-repository";
    },
  },
};

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 Event on UserSketch

Description:Create an event. [See the documentation](https://usersketch.readme.io/reference/post_api-customer-event-create)

Version:0.0.11

Key:usersketch-create-event

View on GitHub

UserSketch Overview#

The UserSketch API lets you pull user details like names, emails, locations, and job titles, to create realistic user personas for your apps or services. Integrating the UserSketch API with Pipedream unlocks the potential to automate the creation of these personas, enrich CRM data, or enhance user testing with minimal effort. Pipedream's serverless platform facilitates the creation of complex workflows, connecting UserSketch with a vast array of other apps and services to streamline your processes.

Action Code#

import app from "../../usersketch.app.mjs";
import constants from "../common/constants.mjs";

export default {
  name: "Create Event",
  version: "0.0.11",
  key: "usersketch-create-event",
  description: "Create an event. [See the documentation](https://usersketch.readme.io/reference/post_api-customer-event-create)",
  type: "action",
  props: {
    app,
    email: {
      type: "string",
      label: "Email",
      description: "Email of the user",
    },
    eventType: {
      type: "string",
      label: "Event type",
      description: "Type of the event",
      options: constants.EVENT_TYPES,
    },
    date: {
      type: "string",
      label: "Date",
      description: "The time when the event occurred. Can be in Unix timestamp or ISO8601 format, for example, `2023-12-08T10:00:00+07:00`",
      optional: true,
    },
    link: {
      type: "string",
      label: "Link",
      description: "The link to the event",
    },
    message: {
      type: "string",
      label: "Message",
      description: "The note or email's HTML or text body",
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "The subject of the email",
    },
  },
  async run({ $ }) {
    const date = !this.date
      ? Math.floor(Date.now() / 1000)
      : Math.floor((new Date(this.date.length === 10
        ? +this.date * 1000
        : this.date)).getTime() / 1000);

    const response = await this.app.createEvent({
      $,
      data: {
        customerData: {
          email: this.email,
        },
        eventData: {
          eventType: this.eventType,
          date,
          link: this.link,
          message: this.message,
          subject: this.subject,
        },
      },
    });

    if (response.success) {
      $.export("$summary", "Successfully created event");
    }

    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
UserSketch	`app`	`app`	This component uses the UserSketch app.
Email	`email`	`string`	Email of the user
Event type	`eventType`	`string`	Select a value from the drop down menu:`{ "label": "Email", "value": "email" }{ "label": "Chat", "value": "chat" }{ "label": "Phone call", "value": "phone_call" }{ "label": "SMS", "value": "sms" }{ "label": "Payment information", "value": "payment_information" }{ "label": "Note", "value": "note" }`
Date	`date`	`string`	The time when the event occurred. Can be in Unix timestamp or ISO8601 format, for example, `2023-12-08T10:00:00+07:00`
Link	`link`	`string`	The link to the event
Message	`message`	`string`	The note or email's HTML or text body
Subject	`subject`	`string`	The subject of the email

Create Event with UserSketch API on New Commit Comment from GitHub API

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