Identify a user, tie them to their actions and record traits about them with Segment API on New Invoice Entry from Harvest API

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

Trigger workflow on

New Invoice Entry from the Harvest API

Next, do this

Identify a user, tie them to their actions and record traits about them 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 Harvest 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 Invoice Entry trigger
1. Connect your Harvest account
2. Configure Polling interval
3. Select a Account ID
Configure the Identify a user, tie them to their actions and record traits about them action
1. Connect your Segment account
2. Optional- Configure Anonymous ID
3. Optional- Configure Context
4. Optional- Configure Integrations
5. Optional- Configure Timestamp
6. Optional- Configure Traits
7. 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 Invoice Entry on Harvest

Description:Emit new notifications when a new invoice is created

Version:0.0.4

Key:harvest-new-invoice-entry

View on GitHub

Harvest Overview#

Harvest is a time tracking and invoicing tool that can streamline the way freelancers and businesses record time for various projects and tasks. By leveraging the Harvest API on Pipedream, you can automate complex workflows that integrate time tracking data with other business tools. Generate reports, sync project data, and manage invoices with minimal manual intervention. Pipedream's serverless platform lets you create these automations using simple, code-driven components, enabling a seamless connection between Harvest and a multitude of other apps.

Trigger Code#

import harvest from "../../harvest.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "harvest-new-invoice-entry",
  name: "New Invoice Entry",
  description: "Emit new notifications when a new invoice is created",
  version: "0.0.4",
  type: "source",
  props: {
    harvest,
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll Harvest API on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    db: "$.service.db",
    accountId: {
      propDefinition: [
        harvest,
        "accountId",
      ],
    },
  },
  dedupe: "unique",
  async run() {
    const data = [];
    let lastDateChecked = this.harvest.getLastDateChecked(this.db);
    if (!lastDateChecked) {
      lastDateChecked = new Date().toISOString();
      this.harvest.setLastDateChecked(this.db, lastDateChecked);
    }
    const invoices = await this.harvest.listInvoicesPaginated({
      page: 1,
      updatedSince: lastDateChecked,
      accountId: this.accountId,
    });
    for await (const invoice of invoices) {
      data.push(invoice);
    }
    data && data.reverse().forEach((invoice) => {
      this.harvest.setLastDateChecked(this.db, invoice.updated_at);
      this.$emit(invoice,
        {
          id: invoice.id,
          summary: `Invoice number: ${invoice.number}`,
          ts: Date.parse(invoice.updated_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
Harvest	`harvest`	`app`	This component uses the Harvest app.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll Harvest API on this schedule
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Account ID	`accountId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

About Harvest#

Online Time Tracking and Invoicing Software

Action#

Identify a user, tie them to their actions and record traits about them on Segment

Description:Identify lets you tie a user to their actions and record traits about them. It includes a unique User ID and any optional traits you know about them (note requires userId or anonymousId). See the docs [here](https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#identify)

Version:0.2.5

Key:segment-identify

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-identify",
  name: "Identify a user, tie them to their actions and record traits about them",
  description: "Identify lets you tie a user to their actions and record traits about them. It includes a unique User ID and any optional traits you know about them (note requires userId or anonymousId). See the docs [here](https://segment.com/docs/connections/sources/catalog/libraries/server/http-api/#identify)",
  version: "0.2.5",
  type: "action",
  props: {
    segmentApp,
    anonymousId: {
      propDefinition: [
        segmentApp,
        "anonymousId",
      ],
    },
    context: {
      propDefinition: [
        segmentApp,
        "context",
      ],
    },
    integrations: {
      propDefinition: [
        segmentApp,
        "integrations",
      ],
    },
    timestamp: {
      propDefinition: [
        segmentApp,
        "timestamp",
      ],
    },
    traits: {
      type: "object",
      label: "Traits",
      description: "Free-form dictionary of traits of the user, like email or name.",
      optional: true,
    },
    userId: {
      propDefinition: [
        segmentApp,
        "userId",
      ],
    },
  },
  async run({ $ }) {
    return this.segmentApp.identify({
      $,
      data: {
        anonymousId: this.anonymousId,
        context: this.context,
        integrations: this.integrations,
        timestamp: this.timestamp,
        traits: this.traits,
        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
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`
Traits	`traits`	`object`	Free-form dictionary of traits of the user, like email or name.
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.