Record page views on your website with Segment API on New Gist from GitHub API

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

Trigger workflow on

New Gist from the GitHub API

Next, do this

Record page views on your website with the Segment 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 Segment action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Gist trigger
1. Connect your GitHub account
2. Configure timer
Configure the Record page views on your website action
1. Connect your Segment account
2. Optional- Configure Anonymous ID
3. Optional- Configure Context
4. Optional- Configure Integrations
5. Optional- Configure Page Name
6. Optional- Configure Page Properties
7. Optional- Configure Timestamp
8. Optional- Configure User ID
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 Gist on GitHub

Description:Emit new events when new gists are created by the authenticated user. [See the documentatoion](https://docs.github.com/en/rest/gists/gists?apiVersion=20.2.21-28#list-gists-for-the-authenticated-user)

Version:0.2.2

Key:github-new-gist

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-polling.mjs";

export default {
  ...common,
  key: "github-new-gist",
  name: "New Gist",
  description: "Emit new events when new gists are created by the authenticated user. [See the documentatoion](https://docs.github.com/en/rest/gists/gists?apiVersion=20.2.21-28#list-gists-for-the-authenticated-user)",
  version: "0.2.2",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async getItems() {
      return this.github.getGists();
    },
    getItemMetadata(item) {
      return {
        summary: `New gist: ${item.id}`,
        ts: Date.parse(item.created_at),
      };
    },
  },
};

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.
	`timer`	`$.interface.timer`
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#

Record page views on your website on Segment

Description:The page method lets you record page views on your website, along with optional extra information about the page being viewed (note requires userId or anonymousId). See the docs [here](https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#page)

Version:0.2.4

Key:segment-page

View on GitHub

Segment Overview#

The Segment API enables you to collect, manage, and route your customer analytics data to various tools for marketing, analytics, and data warehousing. By harnessing the Segment API on Pipedream, you can automate the ingestion and syncing of user events and properties to multiple destinations, allowing you to create seamless data pipelines without manual intervention. Pipedream's serverless platform empowers you to build custom workflows that react to events in real-time, enrich data, or trigger actions across your tech stack.

Action Code#

import segmentApp from "../../segment.app.mjs";

export default {
  key: "segment-page",
  name: "Record page views on your website",
  description: "The page method lets you record page views on your website, along with optional extra information about the page being viewed (note requires userId or anonymousId). See the docs [here](https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#page)",
  version: "0.2.4",
  type: "action",
  props: {
    segmentApp,
    anonymousId: {
      propDefinition: [
        segmentApp,
        "anonymousId",
      ],
    },
    context: {
      propDefinition: [
        segmentApp,
        "context",
      ],
    },
    integrations: {
      propDefinition: [
        segmentApp,
        "integrations",
      ],
    },
    label: {
      type: "string",
      label: "Page Name",
      description: "Name of the page",
      optional: true,
    },
    properties: {
      type: "object",
      label: "Page Properties",
      description: "Free-form dictionary of properties of the page, like url and referrer",
      optional: true,
    },
    timestamp: {
      propDefinition: [
        segmentApp,
        "timestamp",
      ],
    },
    userId: {
      propDefinition: [
        segmentApp,
        "userId",
      ],
    },
  },
  async run({ $ }) {
    return this.segmentApp.page({
      $,
      data: {
        anonymousId: this.anonymousId,
        context: this.context,
        integrations: this.integrations,
        label: this.name,
        properties: this.properties,
        timestamp: this.timestamp,
        userId: this.userId,
      },
    });
  },
};

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
Segment	`segmentApp`	`app`	This component uses the Segment app.
Anonymous ID	`anonymousId`	`string`	A pseudo-unique substitute for a User ID, for cases when you don't have an absolutely unique identifier. A User ID or an Anonymous ID is required.
Context	`context`	`object`	Dictionary of extra information that provides useful context about a message, but is not directly related to the API call like ip address or locale
Integrations	`integrations`	`object`	Dictionary of destinations to either enable or disable
Page Name	`label`	`string`	Name of the page
Page Properties	`properties`	`object`	Free-form dictionary of properties of the page, like url and referrer
Timestamp	`timestamp`	`string`	Timestamp when the message itself took place, defaulted to the current time by the Segment Tracking API. It is an ISO-8601 date string. For example, `2022-04-08T17:32:11.318Z`
User ID	`userId`	`string`	Unique identifier for the user in your database., A User ID or an Anonymous ID is required.

Action Authentication#

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

Segment's APIs are accessed programmatically using access tokens, as well as write keys.

Access Token

Create access tokens via the Access Management page in your account: https://app.segment.com/{your-workspace-name}/settings/access-management. See "Get a Token" for more details. Please note, that you must be on a Team or Business plan to create an access token.

Write Key

You will also need to find your write key, which is a unique identifier for your Source. To find a write key, you first need to create a non-Cloud Source such as a website, server, or mobile source. (Cloud-sources do not have write keys, as they use a token or key from your account with that service.) Then, in the Source, go to “Settings’, and then go to “API Keys”. See "Locating Your Write Key" for more details.