Capture Event with PostHog API on Weekly schedule from Schedule API

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

Trigger workflow on

Weekly schedule from the Schedule API

Next, do this

Capture Event with the PostHog 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 Schedule trigger and PostHog action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Weekly schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Capture Event action
1. Connect your PostHog account
2. Configure Project API Key
3. Select a Organization ID
4. Select a Project ID
5. Select a Event
6. 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#

Weekly schedule on Schedule

Description:Trigger your workflow on one or more days each week at a specific time (with timezone support).

Version:0.0.1

Key:schedule-weekly

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

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

export default {
  name: "Weekly schedule",
  version: "0.0.1",
  key: "schedule-weekly",
  type: "source",
  description: "Trigger your workflow on one or more days each week at a specific time (with timezone support).",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
      default: {
        cron: "0 10 * * 1",
      },
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Capture Event on PostHog

Description:Captures a given event within the PostHog system. [See the documentation](https://posthog.com/docs/api/post-only-endpoints#single-event)

Version:0.0.1

Key:posthog-capture-event

View on GitHub

PostHog Overview#

The PostHog API lets you track events, update user properties, and extract analytics to understand user behavior within your applications. Integrating this API into Pipedream workflows allows you to automate actions based on event data, sync user properties across platforms, and trigger alerts or notifications.

Action Code#

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

export default {
  key: "posthog-capture-event",
  name: "Capture Event",
  description: "Captures a given event within the PostHog system. [See the documentation](https://posthog.com/docs/api/post-only-endpoints#single-event)",
  version: "0.0.1",
  type: "action",
  props: {
    posthog,
    projectApiKey: {
      type: "string",
      label: "Project API Key",
      description: "The Project API Key in your Project Settings. This key can only create new events. It can't read events or any of your other data stored with PostHog, so it's safe to use in public apps.",
    },
    organizationId: {
      propDefinition: [
        posthog,
        "organizationId",
      ],
    },
    projectId: {
      propDefinition: [
        posthog,
        "projectId",
        (c) => ({
          organizationId: c.organizationId,
        }),
      ],
    },
    event: {
      propDefinition: [
        posthog,
        "event",
        (c) => ({
          projectId: c.projectId,
        }),
      ],
    },
    properties: {
      type: "object",
      label: "Properties",
      description: "The properties to include in the event",
      optional: true,
    },
  },
  async run({ $ }) {
    const properties = typeof this.properties === "string"
      ? JSON.parse(this.properties)
      : this.properties;
    const { distinct_id: distinctId } = await this.posthog.getUser({
      $,
    });
    const response = await this.posthog.captureEvent({
      $,
      data: {
        event: this.event,
        api_key: this.projectApiKey,
        properties: {
          ...properties,
          distinct_id: distinctId,
        },
      },
    });
    $.export("$summary", `Successfully captured event ${this.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
PostHog	`posthog`	`app`	This component uses the PostHog app.
Project API Key	`projectApiKey`	`string`	The Project API Key in your Project Settings. This key can only create new events. It can't read events or any of your other data stored with PostHog, so it's safe to use in public apps.
Organization ID	`organizationId`	`string`	Select a value from the drop down menu.
Project ID	`projectId`	`string`	Select a value from the drop down menu.
Event	`event`	`string`	Select a value from the drop down menu.
Properties	`properties`	`object`	The properties to include in the event

Action Authentication#

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

To retrieve your API Key,