@pipedream/pitchlane 0.0.1 → 0.1.0

package/README.md

@@ -0,0 +1,11 @@
+# Overview
+
+The Pitchlane API enables users to automate and integrate media planning and buying processes. This API can streamline the creation, management, and optimization of advertising campaigns across various channels. By utilizing Pitchlane within Pipedream, users can connect their media planning tools with other business systems (like CRM, analytics, or communication platforms), automate repetitive tasks, and orchestrate complex workflows that respond to real-time data changes.
+
+# Example Use Cases
+
+- **Campaign Performance Sync to Google Sheets**: Automate the process of syncing detailed campaign performance data from Pitchlane to a Google Sheets document. This workflow can be set to trigger every time a campaign's data is updated, ensuring that stakeholders have access to the most current information without manual intervention. Useful for real-time reporting and data aggregation for meetings or audits.
+
+- **Slack Notifications for Campaign Alerts**: Set up an automated alert system where any critical updates or metrics (like budget overruns or KPI achievements) are instantly sent as notifications to a designated Slack channel. This ensures that the marketing team stays informed about important developments in real-time, promoting swift decision-making and immediate responses to potential issues.
+
+- **Automated Email Reports with SendGrid**: Design a workflow where weekly or monthly email summaries of campaign performances are automatically generated and sent through SendGrid. This can include key performance indicators, budget usage, and other relevant data tailored to the needs of different stakeholders. This eliminates the need for manual report preparation and ensures consistent updates are delivered to executives or clients.

package/actions/create-campaign-video/create-campaign-video.mjs

@@ -0,0 +1,101 @@
+import pitchlane from "../../pitchlane.app.mjs";
+import { parseObject } from "../../common/utils.mjs";
+
+export default {
+  key: "pitchlane-create-campaign-video",
+  name: "Create Campaign Video",
+  description: "Creates a new video for a campaign. [See the documentation](https://docs.pitchlane.com/reference#tag/videos/POST/campaigns/{campaignId}/videos)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    pitchlane,
+    campaignId: {
+      propDefinition: [
+        pitchlane,
+        "campaignId",
+      ],
+      reloadProps: true,
+    },
+    title: {
+      type: "string",
+      label: "Title",
+      description: "The title of the video to create. If not specified, the title will be generated following the campaign's titleTemplate.",
+      optional: true,
+    },
+    queueForRender: {
+      type: "boolean",
+      label: "Queue for Render",
+      description: "If `true`, the video will automatically be added to the rendering queue to be rendered (default). If `false`, the video will be created in Pitchlane but will not be rendered until the \"Render all Videos\" button is pressed in the Pitchlane UI.",
+      optional: true,
+      default: false,
+    },
+  },
+  async additionalProps() {
+    const props = {};
+    if (!this.campaignId) {
+      return props;
+    }
+    try {
+      const {
+        variableSchema, leadSchemaMapping,
+      } = await this.pitchlane.getCampaignSchemas({
+        campaignId: this.campaignId,
+      });
+      const requiredVariables = {};
+      for (const [
+        key,
+        value,
+      ] of Object.entries(variableSchema)) {
+        if (value.required) {
+          const variableKey = key.split("_")[0];
+          requiredVariables[variableKey] = true;
+        }
+      }
+      for (const key of Object.keys(leadSchemaMapping)) {
+        props[key] = {
+          type: "string",
+          label: key,
+          optional: !requiredVariables[key],
+        };
+      }
+    } catch {
+      props.variables = {
+        type: "object",
+        label: "Variables",
+        description: "The schema variables to be used in the video",
+      };
+    }
+    return props;
+  },
+  async run({ $ }) {
+    const {
+      pitchlane,
+      campaignId,
+      title,
+      queueForRender,
+      variables,
+      ...otherVariables
+    } = this;
+
+    const response = await pitchlane.createCampaignVideo({
+      $,
+      campaignId,
+      data: {
+        queueForRender,
+        title,
+        variables: {
+          ...parseObject(variables),
+          ...otherVariables,
+        },
+      },
+    });
+
+    $.export("$summary", `Successfully created video with ID: ${response.id}`);
+    return response;
+  },
+};

package/actions/get-campaign-schemas/get-campaign-schemas.mjs

@@ -0,0 +1,31 @@
+import pitchlane from "../../pitchlane.app.mjs";
+
+export default {
+  key: "pitchlane-get-campaign-schemas",
+  name: "Get Campaign Schemas",
+  description: "Retrieve the variable schema and lead schema mapping for a specific campaign. [See the documentation](https://docs.pitchlane.com/reference#tag/campaigns/GET/campaigns/{campaignId}/schemas)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    pitchlane,
+    campaignId: {
+      propDefinition: [
+        pitchlane,
+        "campaignId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.pitchlane.getCampaignSchemas({
+      $,
+      campaignId: this.campaignId,
+    });
+    $.export("$summary", `Successfully retrieved the variable schema and lead schema mapping for campaign ID: ${this.campaignId}`);
+    return response;
+  },
+};

package/actions/list-campaigns/list-campaigns.mjs

@@ -0,0 +1,26 @@
+import pitchlane from "../../pitchlane.app.mjs";
+
+export default {
+  key: "pitchlane-list-campaigns",
+  name: "List Campaigns",
+  description: "Lists all campaigns. [See the documentation](https://docs.pitchlane.com/reference#tag/campaigns/GET/campaigns)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    pitchlane,
+  },
+  async run({ $ }) {
+    const response = await this.pitchlane.listCampaigns({
+      $,
+    });
+    $.export("$summary", `Successfully listed ${response?.length} campaign${response?.length === 1
+      ? ""
+      : "s"}.`);
+    return response;
+  },
+};

package/common/utils.mjs

@@ -0,0 +1,26 @@
+export const parseObject = (obj) => {
+  if (!obj) return undefined;
+
+  if (typeof obj === "string") {
+    try {
+      return JSON.parse(obj);
+    } catch (e) {
+      return obj;
+    }
+
+  }
+  if (Array.isArray(obj)) {
+    return obj.map((item) => parseObject(item));
+  }
+
+  if (typeof obj === "object") {
+    for (const [
+      key,
+      value,
+    ] of Object.entries(obj)) {
+      obj[key] = parseObject(value);
+    }
+  }
+
+  return obj;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/pitchlane",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Pipedream Pitchlane Components",
   "main": "pitchlane.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.1.1"
   }
 }

package/pitchlane.app.mjs

@@ -1,11 +1,73 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "pitchlane",
-  propDefinitions: {},
+  propDefinitions: {
+    campaignId: {
+      type: "string",
+      label: "Campaign ID",
+      description: "The ID of the campaign",
+      async options() {
+        const campaigns = await this.listCampaigns();
+        return campaigns?.map((campaign) => ({
+          label: campaign.name,
+          value: campaign.id,
+        })) || [];
+      },
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return "https://app.pitchlane.com/api/public/v1";
+    },
+    _makeRequest({
+      $ = this, path, ...opts
+    }) {
+      return axios($, {
+        url: `${this._baseUrl()}${path}`,
+        headers: {
+          "X-API-Key": this.$auth.api_key,
+        },
+        ...opts,
+      });
+    },
+    createWebhook(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/webhooks",
+        ...opts,
+      });
+    },
+    deleteWebhook(opts = {}) {
+      return this._makeRequest({
+        method: "DELETE",
+        path: "/webhooks",
+        ...opts,
+      });
+    },
+    listCampaigns(opts = {}) {
+      return this._makeRequest({
+        path: "/campaigns",
+        ...opts,
+      });
+    },
+    getCampaignSchemas({
+      campaignId, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/campaigns/${campaignId}/schemas`,
+        ...opts,
+      });
+    },
+    createCampaignVideo({
+      campaignId, ...opts
+    }) {
+      return this._makeRequest({
+        method: "POST",
+        path: `/campaigns/${campaignId}/videos`,
+        ...opts,
+      });
     },
   },
-};
+};

package/sources/common/base-webhook.mjs

@@ -0,0 +1,54 @@
+import pitchlane from "../../pitchlane.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  props: {
+    pitchlane,
+    db: "$.service.db",
+    http: {
+      type: "$.interface.http",
+      customResponse: true,
+    },
+    campaignId: {
+      propDefinition: [
+        pitchlane,
+        "campaignId",
+      ],
+      optional: true,
+    },
+  },
+  hooks: {
+    async activate() {
+      await this.pitchlane.createWebhook({
+        data: {
+          webhookUrl: this.http.endpoint,
+          campaignId: this.campaignId,
+          trigger: this.getEventType(),
+        },
+      });
+    },
+    async deactivate() {
+      await this.pitchlane.deleteWebhook({
+        params: {
+          webhookUrl: this.http.endpoint,
+          campaignId: this.campaignId,
+          trigger: this.getEventType(),
+        },
+      });
+    },
+  },
+  methods: {
+    getEventType() {
+      throw new ConfigurationError("getEventType is not implemented");
+    },
+    generateMeta() {
+      throw new ConfigurationError("generateMeta is not implemented");
+    },
+  },
+  async run({ body }) {
+    this.http.respond({
+      status: 200,
+    });
+    this.$emit(body, this.generateMeta(body));
+  },
+};

package/sources/new-video-created/new-video-created.mjs

@@ -0,0 +1,26 @@
+import common from "../common/base-webhook.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "pitchlane-new-video-created",
+  name: "New Video Created (Instant)",
+  description: "Emit new event when a video is created in Pitchlane. [See the documentation](https://docs.pitchlane.com/reference#tag/webhooks/POST/webhooks)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getEventType() {
+      return "VIDEO_CREATED";
+    },
+    generateMeta(body) {
+      return {
+        id: body.video.id,
+        summary: `New video created with ID: ${body.video.id}`,
+        ts: Date.parse(body.video.createdAt),
+      };
+    },
+  },
+  sampleEmit,
+};

package/sources/new-video-created/test-event.mjs

@@ -0,0 +1,63 @@
+export default {
+  "video": {
+    "id": "Q2ubfK7gTp8Y_NAlg2M2T",
+    "shortId": "l3OIfKOHOq22",
+    "title": "Video for Test",
+    "createdAt": "2026-01-19T20:55:31.210Z",
+    "meta": {},
+    "importId": "API import",
+    "campaignId": "O7kkxLnMYXUpAM1VzqHg4",
+    "campaignName": "My First Campaign",
+    "thumbnailUrl": null,
+    "thumbnailStorageUrl": null,
+    "thumbnailUrlPNG": null,
+    "thumbnailStorageUrlPNG": null,
+    "thumbnailEmbed": null,
+    "thumbnailStorageEmbed": null,
+    "thumbnailEmbedPNG": null,
+    "thumbnailStorageEmbedPNG": null,
+    "videoFileUrl": null,
+    "videoUrl": null,
+    "originalRow": {
+      "website": "https://example.com",
+      "first_name": "Test",
+      "last_name": "User",
+      "email": "test@example.com",
+      "company_name": "Pipedream"
+    },
+    "overrideRow": {
+      "website": "https://example.com"
+    }
+  },
+  "rawVideo": {
+    "_id": "Q2ubfK7gTp8Y_NAlg2M2T",
+    "shortId": "l3OIfKOHOq22",
+    "importId": "API import",
+    "campaignId": "O7kkxLnMYXUpAM1VzqHg4",
+    "meta": {},
+    "createdAt": "2026-01-19T20:55:31.210Z",
+    "storagePaths": {},
+    "userId": "google-oauth2|117665792695448708367",
+    "originalRow": {
+      "website": "https://example.com",
+      "first_name": "Test",
+      "last_name": "User",
+      "email": "test@example.com",
+      "company_name": "Pipedream"
+    },
+    "importSource": "API",
+    "title": "Video for Test",
+    "overrideRow": {
+      "website": "https://example.com"
+    },
+    "_backupVariables": {
+      "first_name": "Test",
+      "last_name": "User",
+      "email": "test@example.com",
+      "company_name": "Pipedream",
+      "website_0": "https://example.com"
+    }
+  },
+  "event": "VIDEO_CREATED",
+  "eventAt": "2026-01-19T20:55:31.279Z"
+}

package/sources/new-video-first-viewed/new-video-first-viewed.mjs

@@ -0,0 +1,26 @@
+import common from "../common/base-webhook.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "pitchlane-new-video-first-viewed",
+  name: "New Video First Viewed (Instant)",
+  description: "Emit new event when a video is first viewed in Pitchlane. [See the documentation](https://docs.pitchlane.com/reference#tag/webhooks/POST/webhooks)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getEventType() {
+      return "VIDEO_FIRST_VIEWED";
+    },
+    generateMeta(body) {
+      return {
+        id: body.video._id,
+        summary: `New video first viewed with ID: ${body.video._id}`,
+        ts: Date.parse(body.video.viewedAt),
+      };
+    },
+  },
+  sampleEmit,
+};

package/sources/new-video-first-viewed/test-event.mjs

@@ -0,0 +1,69 @@
+export default {
+  "video": {
+    "_id": "eGW3A4OoTqpLMmYidtEC0",
+    "shortId": "2JtvheObJPXE",
+    "importId": "API import",
+    "campaignId": "O7kkxLnMYXUpAM1VzqHg4",
+    "meta": {},
+    "createdAt": "2026-01-19T20:51:50.462Z",
+    "storagePaths": {
+      "video": "u6FTur0CpNU89BrMeRXn4.mp4",
+      "video_mp4": "u6FTur0CpNU89BrMeRXn4.mp4",
+      "thumbnail": "I_sDsMlA0xhJZl4XPDixx.gif",
+      "thumbnail_png": "RBXXeah4fVdpxxwXib3dZ.png"
+    },
+    "userId": "google-oauth2|117665792695448708367",
+    "originalRow": {
+      "website": "https://example.com",
+      "first_name": "Test",
+      "last_name": "User",
+      "email": "test@example.com",
+      "company_name": "Pipedream"
+    },
+    "originalRowIndex": null,
+    "importSource": "API",
+    "title": "Video for Test",
+    "overrideRow": {
+      "website": "https://example.com"
+    },
+    "_backupVariables": {
+      "first_name": "Test",
+      "last_name": "User",
+      "email": "test@example.com",
+      "company_name": "Pipedream",
+      "website_0": "https://example.com"
+    },
+    "bullmqRootJobId": "864f4024-eede-4487-aefe-df05b4829dbe",
+    "queuedAt": "2026-01-19T20:58:10.055Z",
+    "renderingStatus": "RENDERED",
+    "startedProcessingAt": "2026-01-19T20:58:10.839Z",
+    "recordingOutputs": {
+      "pageResults": {
+        "0": {
+          "pageResult": {
+            "scrollableElementResult": {
+              "found": false
+            },
+            "hasMotionGraphics": false,
+            "usedGPU": false,
+            "receivedFrames": 1,
+            "html": null,
+            "languagePreference": "en-US",
+            "proxyServer": null
+          }
+        }
+      }
+    },
+    "backgroundRecordedAt": "2026-01-19T20:59:10.432Z",
+    "startedRenderingAt": "2026-01-19T20:59:11.914Z",
+    "renderedAt": "2026-01-19T21:00:16.533Z",
+    "triggeredWebhooks": [
+      "VIDEO_RENDERED"
+    ],
+    "campaignName": "My First Campaign"
+  },
+  "viewedAt": "2026-01-19T21:05:42.940Z",
+  "eventAt": "2026-01-19T21:05:42.940Z",
+  "viewerUrl": "https://playpitchlane.com/video/2JtvheObJPXE",
+  "event": "VIDEO_FIRST_VIEWED"
+}

package/sources/new-video-rendered/new-video-rendered.mjs

@@ -0,0 +1,26 @@
+import common from "../common/base-webhook.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "pitchlane-new-video-rendered",
+  name: "New Video Rendered (Instant)",
+  description: "Emit new event when a video is rendered in Pitchlane. [See the documentation](https://docs.pitchlane.com/reference#tag/webhooks/POST/webhooks)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getEventType() {
+      return "VIDEO_RENDERED";
+    },
+    generateMeta(body) {
+      return {
+        id: body.video.id,
+        summary: `New video rendered with ID: ${body.video.id}`,
+        ts: Date.parse(body.video.renderedAt),
+      };
+    },
+  },
+  sampleEmit,
+};

package/sources/new-video-rendered/test-event.mjs

@@ -0,0 +1,100 @@
+export default {
+  "video": {
+    "id": "Q2ubfK7gTp8Y_NAlg2M2T",
+    "shortId": "l3OIfKOHOq22",
+    "title": "Video for Test",
+    "createdAt": "2026-01-19T20:55:31.210Z",
+    "queuedAt": "2026-01-19T20:55:33.512Z",
+    "startedProcessingAt": "2026-01-19T20:55:34.206Z",
+    "startedRenderingAt": "2026-01-19T20:56:35.937Z",
+    "backgroundRecordedAt": "2026-01-19T20:56:33.886Z",
+    "renderedAt": "2026-01-19T20:57:50.724Z",
+    "meta": {},
+    "importId": "API import",
+    "originalRowIndex": null,
+    "campaignId": "O7kkxLnMYXUpAM1VzqHg4",
+    "renderingStatus": "RENDERED",
+    "campaignName": "My First Campaign",
+    "thumbnailUrl": "https://playpitchlane.com/thumbnail/l3OIfKOHOq22.gif",
+    "thumbnailStorageUrl": "https://storage.googleapis.com/videos-eu/onSzrk5iU0Q4i_6JrIXPM.gif",
+    "thumbnailUrlPNG": "https://playpitchlane.com/thumbnail/l3OIfKOHOq22.png",
+    "thumbnailStorageUrlPNG": "https://storage.googleapis.com/videos-eu/sp6iLQbA7dsFOfK3Hqz5u.png",
+    "thumbnailEmbed": "<div><a target=\"_blank\" href=\"https://playpitchlane.com/video/l3OIfKOHOq22\"><img style=\"margin:0px;box-sizing:border-box;padding:0px;width:100%;max-width:300px;height:auto\" src=\"https://playpitchlane.com/thumbnail/l3OIfKOHOq22.gif\" alt=\"Video for Test\"></a><br /></div>",
+    "thumbnailStorageEmbed": "<div><a target=\"_blank\" href=\"https://playpitchlane.com/video/l3OIfKOHOq22\"><img style=\"margin:0px;box-sizing:border-box;padding:0px;width:100%;max-width:300px;height:auto\" src=\"https://storage.googleapis.com/videos-eu/onSzrk5iU0Q4i_6JrIXPM.gif\" alt=\"Video for Test\"></a><br /></div>",
+    "thumbnailEmbedPNG": "<div><a target=\"_blank\" href=\"https://playpitchlane.com/video/l3OIfKOHOq22\"><img style=\"margin:0px;box-sizing:border-box;padding:0px;width:100%;max-width:300px;height:auto\" src=\"https://storage.googleapis.com/videos-eu/sp6iLQbA7dsFOfK3Hqz5u.png\" alt=\"Video for Test\"></a><br /></div>",
+    "thumbnailStorageEmbedPNG": "<div><a target=\"_blank\" href=\"https://playpitchlane.com/video/l3OIfKOHOq22\"><img style=\"margin:0px;box-sizing:border-box;padding:0px;width:100%;max-width:300px;height:auto\" src=\"https://storage.googleapis.com/videos-eu/sp6iLQbA7dsFOfK3Hqz5u.png\" alt=\"Video for Test\"></a><br /></div>",
+    "videoFileUrl": "https://storage.googleapis.com/videos-eu/oO5uUhlgpcwEj8kugZhNx.mp4",
+    "videoUrl": "https://playpitchlane.com/video/l3OIfKOHOq22",
+    "originalRow": {
+      "website": "https://example.com",
+      "first_name": "Test",
+      "last_name": "User",
+      "email": "test@example.com",
+      "company_name": "Pipedream"
+    },
+    "overrideRow": {
+      "website": "https://example.com"
+    }
+  },
+  "rawVideo": {
+    "_id": "Q2ubfK7gTp8Y_NAlg2M2T",
+    "shortId": "l3OIfKOHOq22",
+    "importId": "API import",
+    "campaignId": "O7kkxLnMYXUpAM1VzqHg4",
+    "meta": {},
+    "createdAt": "2026-01-19T20:55:31.210Z",
+    "storagePaths": {
+      "video": "oO5uUhlgpcwEj8kugZhNx.mp4",
+      "video_mp4": "oO5uUhlgpcwEj8kugZhNx.mp4",
+      "thumbnail": "onSzrk5iU0Q4i_6JrIXPM.gif",
+      "thumbnail_png": "sp6iLQbA7dsFOfK3Hqz5u.png"
+    },
+    "userId": "google-oauth2|117665792695448708367",
+    "originalRow": {
+      "website": "https://example.com",
+      "first_name": "Test",
+      "last_name": "User",
+      "email": "test@example.com",
+      "company_name": "Pipedream"
+    },
+    "originalRowIndex": null,
+    "importSource": "API",
+    "title": "Video for Test",
+    "overrideRow": {
+      "website": "https://example.com"
+    },
+    "_backupVariables": {
+      "first_name": "Test",
+      "last_name": "User",
+      "email": "test@example.com",
+      "company_name": "Pipedream",
+      "website_0": "https://example.com"
+    },
+    "bullmqRootJobId": "6af73ea5-7706-46d8-a8b1-b60d3d4a2be2",
+    "queuedAt": "2026-01-19T20:55:33.512Z",
+    "renderingStatus": "RENDERED",
+    "startedProcessingAt": "2026-01-19T20:55:34.206Z",
+    "recordingOutputs": {
+      "pageResults": {
+        "0": {
+          "pageResult": {
+            "scrollableElementResult": {
+              "found": false
+            },
+            "hasMotionGraphics": false,
+            "usedGPU": false,
+            "receivedFrames": 1,
+            "html": null,
+            "languagePreference": "en-US",
+            "proxyServer": null
+          }
+        }
+      }
+    },
+    "backgroundRecordedAt": "2026-01-19T20:56:33.886Z",
+    "startedRenderingAt": "2026-01-19T20:56:35.937Z",
+    "renderedAt": "2026-01-19T20:57:50.724Z"
+  },
+  "event": "VIDEO_RENDERED",
+  "eventAt": "2026-01-19T20:57:50.767Z"
+}