@pipedream/mixpanel 0.6.0 → 0.7.0

package/actions/emit-event-to/emit-event-to.mjs

@@ -1,45 +1,49 @@
+// x-pd-ai: optimized
 // legacy_hash_id: a_Nqir27
-import Mixpanel from "mixpanel";
+import mixpanel from "../../mixpanel.app.mjs";
 
 export default {
   key: "mixpanel-emit-event-to",
-  name: "mixpanel.track",
-  description: "Send an event to mixpanel",
-  version: "0.3.1",
+  name: "Track Event",
+  description: "Send a single event to Mixpanel, attributing it to a user. To query analytics (event counts, funnels, retention, user profiles), connect the separate Mixpanel (Service Account) app, since Mixpanel's query APIs do not accept a project token. [See the documentation](https://docs.mixpanel.com/reference/track-event)",
+  version: "0.4.0",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   type: "action",
   props: {
-    mixpanel: {
-      type: "app",
-      app: "mixpanel",
-    },
+    mixpanel,
     event_name: {
       type: "string",
-      description: "The name of the event. This can be anything the user does - 'Button Click', 'Sign Up', 'Item Purchased', etc.",
+      label: "Event Name",
+      description: "The name of the event, for example `Sign Up`, `Button Click`, or `Item Purchased`. Event names are case-sensitive, and reusing an existing name is what groups events together in reports.",
     },
     distinct_id: {
       type: "string",
+      label: "Distinct ID",
+      description: "The Mixpanel `distinct_id` of the user who performed the event, for example `user_123`. Use the same stable identifier you send with your other Mixpanel events so that repeat events attribute to the same profile.",
     },
     properties: {
       type: "object",
-      description: "A set of properties to include with the event you're sending. These describe the user who did the event or details about the event itself.",
+      label: "Properties",
+      description: "Additional properties to attach to the event, describing either the user or the event itself. Example: `{\"plan\": \"pro\", \"source\": \"onboarding\"}`.",
+      optional: true,
     },
   },
-  async run() {
-    const mixpanel = await Mixpanel.init(this.mixpanel.$auth.token, {
-      protocol: "https",
+  async run({ $ }) {
+    const payload = Object.assign({}, this.properties, {
+      "distinct_id": this.distinct_id,
     });
 
-    // We purposely separated distinct_id to make it explicit; however, we include it in the return value
-    await new Promise((resolve) => mixpanel.track(
-      this.event_name,
-      Object.assign({
-        "distinct_id": this.distinct_id,
-      }, this.properties),
-      resolve,
-    ));
+    await this.mixpanel.trackEvent({
+      event: this.event_name,
+      properties: payload,
+    });
 
-    return Object.assign({
-      "distinct_id": this.distinct_id,
-    }, this.properties);
+    $.export("$summary", `Tracked event "${this.event_name}" for ${this.distinct_id}`);
+
+    return payload;
   },
 };

package/mixpanel.app.mjs

@@ -1,11 +1,28 @@
+// x-pd-ai: optimized
+import Mixpanel from "mixpanel";
+
 export default {
   type: "app",
   app: "mixpanel",
   propDefinitions: {},
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _client() {
+      return Mixpanel.init(this.$auth.token, {
+        protocol: "https",
+      });
+    },
+    trackEvent({
+      event, properties,
+    }) {
+      return new Promise((resolve, reject) => this._client().track(
+        event,
+        {
+          ...properties,
+        },
+        (error) => error
+          ? reject(error)
+          : resolve(),
+      ));
     },
   },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/mixpanel",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Pipedream mixpanel Components",
   "main": "mixpanel.app.mjs",
   "keywords": [
@@ -13,6 +13,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^3.0.0"
+    "@pipedream/platform": "^3.1.1",
+    "mixpanel": "^0.23.0"
   }
 }

package/README.md

@@ -1,11 +0,0 @@
-# Overview
-
-Mixpanel's API allows you to track user interactions with your web and mobile applications, providing insights through data analysis. You can capture events, update user profiles, and segment data based on user actions. Integrating Mixpanel with Pipedream enables you to automate responses to these events, sync data across services, and trigger workflows that can enhance user engagement and improve retention.
-
-# Example Use Cases
-
-- **User Segmentation for Email Campaigns**: When Mixpanel identifies a user segment that performs a specific action, say, completing a tutorial, you can use Pipedream to trigger an automated email through SendGrid or Mailgun. This email could provide additional resources or incentives, encouraging further engagement.
-
-- **Slack Alerts for High-Value Features**: Set up a Pipedream workflow that listens for Mixpanel events related to high-value features. Whenever usage spikes or a VIP customer interacts with the feature, send a notification to a designated Slack channel, keeping your team informed in real-time.
-
-- **Automated User Onboarding**: Combine Mixpanel's data with Pipedream to create a tailored onboarding experience. When a new user signs up, use Pipedream to enroll them in an onboarding sequence in your CRM, such as Salesforce, and track their progress with Mixpanel events, personalizing the journey based on their behavior.