Capture Event with PostHog API on New Remote Directory Watcher (Password Auth) from SFTP (password-based auth) API

Pipedream makes it easy to connect APIs for PostHog, SFTP (password-based auth) and 2,500+ other apps remarkably fast.

Trigger workflow on

New Remote Directory Watcher (Password Auth) from the SFTP (password-based auth) 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 SFTP (password-based auth) 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 New Remote Directory Watcher (Password Auth) trigger
1. Connect your SFTP (password-based auth) account
2. Configure timer
3. Configure Root directory
4. Configure Maximum watcher depth
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#

New Remote Directory Watcher (Password Auth) on SFTP (password-based auth)

Description:Emit new events when files get created, changed or deleted from a remote directory. [See the docs](https://github.com/theophilusx/ssh2-sftp-client#orgfac43d1)

Version:0.1.2

Key:sftp_password_based_auth-watch-remote-directory

View on GitHub

SFTP (password-based auth) Overview#

SFTP on Pipedream enables secure file management on remote servers directly from your workflows. Utilize this app to automate file uploads, downloads, and synchronization tasks between your systems and SFTP servers. Implement robust data pipelines or deploy content to web servers without manual intervention, all while maintaining a high level of security with password-based authentication.

Trigger Code#

import utils from "../../common/utils.mjs";
import component from "@pipedream/sftp/sources/watch-remote-directory/watch-remote-directory.mjs";

export default {
  ...component,
  props: utils.buildAppProps({
    component,
  }),
  key: "sftp_password_based_auth-watch-remote-directory",
  name: "New Remote Directory Watcher (Password Auth)",
  description: "Emit new events when files get created, changed or deleted from a remote directory. [See the docs](https://github.com/theophilusx/ssh2-sftp-client#orgfac43d1)",
  version: "0.1.2",
  type: "source",
};

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
SFTP (password-based auth)	`app`	`app`	This component uses the SFTP (password-based auth) app.
	`timer`	`$.interface.timer`
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Root directory	`rootDirectory`	`string`	Root directory to be watched. example: `/public`
Maximum watcher depth	`maxDepth`	`integer`	Watch all subdirectories within of the root directory, considering the selected maximum depth.

Trigger Authentication#

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

Below, enter the hostname of the SFTP server you'd like to connect to, your username, and the password you'd like to use to connect.

This app only supports password-based authentication, not authentication via private key. If you need to use a private key to connect to a host, please use the SFTP (key-based auth) app, instead.

About SFTP (password-based auth)#

Interact with an SFTP (SSH File Transfer Protocol) Server using a username and password for auth

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.2

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.2",
  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,