← Gmail + Miestro integrations

Create User with Miestro API on New Email Received from Gmail API

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

Trigger workflow on
New Email Received from the Gmail API
Next, do this
Create User with the Miestro API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

This integration creates a workflow with a Gmail trigger and Miestro action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Select this integration
  2. Configure the New Email Received trigger
    1. Connect your Gmail account
    2. Select a Trigger Type
    3. Optional- Configure Service Account Key JSON
    4. Configure serviceAccountKeyJsonInstructions
    5. Optional- Select a Pub/Sub Topic
    6. Optional- Select a Pub/Sub Topic Name
    7. Optional- Select a Label
    8. Configure permissionAlert
    9. Configure latencyWarningAlert
  3. Configure the Create User action
    1. Connect your Miestro account
    2. Configure Name
    3. Configure Email
    4. Configure Password
    5. Select a Role
  4. Deploy the workflow
  5. Send a test event to validate your setup
  6. 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

Description:Emit new event when a new email is received.
Version:0.1.5
Key:gmail-new-email-received

New Email Received Overview

The Gmail - New Email Received (Instant) source enables you to trigger Pipedream workflows based on real-time changes to your Gmail inbox.

Trigger Code

import gmail from "../../gmail.app.mjs";
import common from "../common/polling-history.mjs";
import {
  axios,
  DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
  ConfigurationError,
} from "@pipedream/platform";
import { PubSub } from "@google-cloud/pubsub";
import { v4 as uuidv4 } from "uuid";
import verifyClient from "../common/verify-client-id.mjs";

export default {
  ...common,
  key: "gmail-new-email-received",
  name: "New Email Received",
  description: "Emit new event when a new email is received.",
  type: "source",
  version: "0.1.5",
  dedupe: "unique",
  props: {
    gmail,
    db: "$.service.db",
    triggerType: {
      type: "string",
      label: "Trigger Type",
      options: [
        "webhook",
        "polling",
      ],
      description:
        "Configuring this source as a `webhook` (instant) trigger requires a custom OAuth client. [Refer to the guide here to get started](https://pipedream.com/apps/gmail/#getting-started).",
      reloadProps: true,
    },
    serviceAccountKeyJson: {
      type: "string",
      label: "Service Account Key JSON",
      optional: true,
      hidden: true,
      reloadProps: true,
    },
    serviceAccountKeyJsonInstructions: {
      type: "alert",
      alertType: "info",
      content: `1) [Create a service account in GCP](https://cloud.google.com/iam/docs/creating-managing-service-accounts) and set the following permission: **Pub/Sub Admin**
        \n2) [Generate a service account key](https://cloud.google.com/iam/docs/creating-managing-service-account-keys)
        \n3) Download the key details in JSON format
        \n4) Open the JSON in a text editor, and **copy and paste its contents here**.
      `,
      hidden: true,
    },
    topicType: {
      type: "string",
      label: "Pub/Sub Topic",
      description:
        "Do you have an existing Pub/Sub topic, or would you like to create a new one?",
      options: [
        "existing",
        "new",
      ],
      optional: true,
      hidden: true,
      reloadProps: true,
    },
    topic: {
      type: "string",
      label: "Pub/Sub Topic Name",
      description: "Select a Pub/Sub topic from your GCP account to watch",
      async options() {
        return this.getTopics();
      },
      optional: true,
      hidden: true,
      reloadProps: true,
    },
    label: {
      propDefinition: [
        gmail,
        "label",
      ],
      default: "INBOX",
      optional: true,
      hidden: true,
    },
    permissionAlert: {
      type: "alert",
      alertType: "error",
      content: `Unable to grant publish permission to Gmail API service account.
      \n1. Navigate to your [Google Cloud PubSub Topics List](https://console.cloud.google.com/cloudpubsub)
      \n2. Select "View Permissions" for the topic you intend to use for this source.
      \n3. Click "ADD PRINCIPAL"
      \n4. Select "Pub/Sub Publisher" for the Role.
      \n5. Enter \`serviceAccount:gmail-api-push@system.gserviceaccount.com\` as the principal. 
      \n6. Click "Save"
      `,
      hidden: true,
    },
    latencyWarningAlert: {
      type: "alert",
      alertType: "warning",
      content:
        "Please allow up to 1 minute for deployment. We're setting up your real-time email notifications behind the scenes.",
      hidden: true,
    },
  },
  async additionalProps(props) {
    const newProps = {};
    if (this.triggerType === "polling") {
      newProps.timer = {
        type: "$.interface.timer",
        default: {
          intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
        },
      };
    }
    if (this.triggerType === "webhook") {
      // verify that a Custom OAuth client is being used
      const isValidClientId = await this.checkClientId();
      if (!isValidClientId) {
        throw new ConfigurationError(
          "Configuring this source as a `webhook` (instant) trigger requires a custom OAuth client. [Refer to the guide here to get started](https://pipedream.com/apps/gmail/#getting-started).",
        );
      }

      newProps.http = "$.interface.http";
      newProps.timer = {
        type: "$.interface.timer",
        default: {
          intervalSeconds: 24 * 60 * 60,
        },
        hidden: true,
      };

      props.serviceAccountKeyJson.hidden = false;
      props.serviceAccountKeyJson.optional = false;
      props.serviceAccountKeyJsonInstructions.hidden = false;

      if (!this.serviceAccountKeyJson) {
        return newProps;
      }

      props.topicType.hidden = false;
      props.topicType.optional = false;

      if (!this.topicType) {
        return newProps;
      }

      // create topic prop
      let topicName = this.topic;
      if (this.topicType === "new") {
        const authKeyJSON = JSON.parse(this.serviceAccountKeyJson);
        const { project_id: projectId } = authKeyJSON;
        topicName = `projects/${projectId}/topics/${this.convertNameToValidPubSubTopicName(
          uuidv4(),
        )}`;
        props.topic.default = topicName;
        props.topic.reloadProps = false;
      } else {
        props.topic.hidden = false;
        props.topic.optional = false;
      }

      if (this.topic || this.topicType === "new") {
        const topic = await this.getOrCreateTopic(topicName);

        // Retrieves the IAM policy for the topic
        let hasPublisherRole;
        try {
          const [
            policy,
          ] = await topic.iam.getPolicy();
          hasPublisherRole = policy.bindings.find(
            ({
              members, role,
            }) =>
              members.includes(
                "serviceAccount:gmail-api-push@system.gserviceaccount.com",
              ) && role === "roles/pubsub.publisher",
          );
        } catch {
          console.log("Could not retrieve iam policy");
        }

        if (!hasPublisherRole) {
          // Grant publish permission to Gmail API service account
          try {
            await topic.iam.setPolicy({
              bindings: [
                {
                  role: "roles/pubsub.publisher",
                  members: [
                    "serviceAccount:gmail-api-push@system.gserviceaccount.com",
                  ],
                },
              ],
            });
            console.log("Permissions granted to Gmail API service account.");
          } catch {
            props.permissionAlert.hidden = false;
            return newProps;
          }
        }

        props.latencyWarningAlert.hidden = false;

        const historyId = await this.setupGmailNotifications(topicName);
        newProps.initialHistoryId = {
          type: "string",
          default: historyId,
          hidden: true,
        };
      }
    }
    props.label.hidden = false;
    return newProps;
  },
  hooks: {
    ...common.hooks,
    async activate() {
      if (this.triggerType === "polling") {
        return;
      }

      const sdkParams = this.sdkParams();
      const pubSubClient = new PubSub(sdkParams);

      const currentTopic = {
        name: this.topic,
      };

      // Create subscription
      const pushEndpoint = this.http.endpoint;
      const subscriptionName =
        this.convertNameToValidPubSubTopicName(pushEndpoint);
      const subscriptionOptions = {
        pushConfig: {
          pushEndpoint,
        },
      };
      const [
        subscriptionResult,
      ] = await pubSubClient
        .topic(currentTopic.name)
        .createSubscription(subscriptionName, subscriptionOptions);
      this._setSubscriptionName(subscriptionResult.name);
    },
    async deactivate() {
      if (this.triggerType === "polling") {
        return;
      }

      const sdkParams = this.sdkParams();
      const pubSubClient = new PubSub(sdkParams);

      const subscriptionName = this._getSubscriptionName();
      if (subscriptionName) {
        await pubSubClient.subscription(subscriptionName).delete();
      }
    },
  },
  methods: {
    ...verifyClient.methods,
    ...common.methods,
    _getTopicName() {
      return this.db.get("topicName");
    },
    _setTopicName(topicName) {
      this.db.set("topicName", topicName);
    },
    _getSubscriptionName() {
      return this.db.get("subscriptionName");
    },
    _setSubscriptionName(subscriptionName) {
      this.db.set("subscriptionName", subscriptionName);
    },
    _getLastProcessedHistoryId() {
      return this.db.get("lastProcessedHistoryId");
    },
    _setLastProcessedHistoryId(lastProcessedHistoryId) {
      this.db.set("lastProcessedHistoryId", lastProcessedHistoryId);
    },
    sdkParams() {
      const authKeyJSON = JSON.parse(this.serviceAccountKeyJson);
      const {
        project_id: projectId, client_email, private_key,
      } = authKeyJSON;
      const sdkParams = {
        credentials: {
          client_email,
          private_key,
        },
        projectId,
      };
      return sdkParams;
    },
    async getTopics() {
      const sdkParams = this.sdkParams();
      const pubSubClient = new PubSub(sdkParams);
      const topics = (await pubSubClient.getTopics())[0];
      if (topics.length > 0) {
        return topics.map((topic) => topic.name);
      }
      return [];
    },
    convertNameToValidPubSubTopicName(name) {
      // For valid names, see https://cloud.google.com/pubsub/docs/admin#resource_names
      return (
        name
          // Must not start with `goog`. We add a `pd-` at the beginning if that's the case.
          .replace(/(^goog.*)/g, "pd-$1")
          // Must start with a letter, otherwise we add `pd-` at the beginning.
          .replace(/^(?![a-zA-Z]+)/, "pd-")
          // Only certain characters are allowed, the rest will be replaced with a `-`.
          .replace(/[^a-zA-Z0-9_\-.~+%]+/g, "-")
      );
    },
    makeRequest({
      $ = this, path, ...opts
    }) {
      return axios($, {
        url: `https://gmail.googleapis.com/gmail/v1${path}`,
        headers: {
          Authorization: `Bearer ${this.gmail.getToken()}`,
        },
        ...opts,
      });
    },
    async setupGmailNotifications(topicName) {
      // Set up Gmail push notifications using OAuth token
      const watchResponse = await this.makeRequest({
        method: "POST",
        path: "/users/me/watch",
        data: {
          topicName,
          labelIds: [
            this.label || "INBOX",
          ],
        },
      });
      console.log("Watch response:", watchResponse);
      return watchResponse.historyId;
    },
    async getOrCreateTopic(name) {
      const sdkParams = this.sdkParams();
      const pubSubClient = new PubSub(sdkParams);
      const topicName = name || this.topic;
      // Create or get Pub/Sub topic
      let topic;
      try {
        [
          topic,
        ] = await pubSubClient.createTopic(topicName);
        console.log(`Topic ${topicName} created.`);
      } catch (error) {
        if (error.code === 6) {
          // Already exists
          topic = pubSubClient.topic(topicName);
        } else {
          throw error;
        }
      }
      return topic;
    },
    getHistoryTypes() {
      return [
        "messageAdded",
      ];
    },
    generateMeta(message) {
      return {
        id: message.id,
        summary: message.snippet,
        ts: +message.internalDate,
      };
    },
    filterHistory(history) {
      return this.label
        ? history.filter(
          (item) =>
            item.messagesAdded?.length &&
              item.messagesAdded[0].message.labelIds &&
              item.messagesAdded[0].message.labelIds.includes(this.label),
        )
        : history.filter((item) => item.messagesAdded?.length);
    },
  },
  async run(event) {
    if (this.triggerType === "polling") {
      let lastHistoryId = this._getLastHistoryId();

      if (!lastHistoryId) {
        lastHistoryId = await this.getHistoryId();
      }
      await this.emitHistories(lastHistoryId);
    }

    if (this.triggerType === "webhook") {
      if (event.timestamp) {
        // event was triggered by timer
        const topicName = this._getTopicName();
        if (topicName) {
          // renew Gmail push notifications
          await this.setupGmailNotifications(topicName);
          return;
        } else {
          // first run, no need to renew push notifications
          this._setTopicName(this.topic);
          this._setLastProcessedHistoryId(this.initialHistoryId);
          return;
        }
      }

      // Extract the Pub/Sub message data
      const pubsubMessage = event.body.message;
      if (!pubsubMessage) {
        return;
      }
      const decodedData = JSON.parse(
        Buffer.from(pubsubMessage.data, "base64").toString(),
      );

      console.log("Decoded Pub/Sub data:", decodedData);

      const { historyId: receivedHistoryId } = decodedData;

      // Retrieve the last processed historyId
      const lastProcessedHistoryId = this._getLastProcessedHistoryId();
      console.log("Last processed historyId:", lastProcessedHistoryId);

      // Use the minimum of lastProcessedHistoryId and the received historyId
      const startHistoryId = Math.min(
        parseInt(lastProcessedHistoryId),
        parseInt(receivedHistoryId),
      );
      console.log("Using startHistoryId:", startHistoryId);

      // Fetch the history
      const historyResponse = await this.gmail.listHistory({
        startHistoryId,
        historyTypes: [
          "messageAdded",
        ],
        labelId: this.label,
      });

      console.log(
        "History response:",
        JSON.stringify(historyResponse, null, 2),
      );

      // Process history to find new messages
      const newMessages = [];
      if (historyResponse.history) {
        for (const historyItem of historyResponse.history) {
          if (historyItem.messagesAdded) {
            newMessages.push(
              ...historyItem.messagesAdded.map((msg) => msg.message),
            );
          }
        }
      }

      console.log("New messages found:", newMessages.length);

      // Fetch full message details for new messages
      const newMessageIds = newMessages?.map(({ id }) => id) || [];
      const messageDetails = await this.gmail.getMessages(newMessageIds);

      if (!messageDetails?.length) {
        return;
      }

      console.log("Fetched message details count:", messageDetails.length);

      // Store the latest historyId in the db
      const latestHistoryId = historyResponse.historyId || receivedHistoryId;
      this._setLastProcessedHistoryId(latestHistoryId);
      console.log("Updated lastProcessedHistoryId:", latestHistoryId);

      messageDetails.forEach((message) => this.emitEvent(message));
    }
  },
};

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.
LabelPropTypeDescription
GmailgmailappThis component uses the Gmail app.
N/Adb$.service.dbThis component uses $.service.db to maintain state between executions.
Trigger TypetriggerTypestringSelect a value from the drop down menu:webhookpolling

Trigger Authentication

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

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

emailprofileopenidhttps://www.googleapis.com/auth/gmail.labelshttps://www.googleapis.com/auth/gmail.sendhttps://www.googleapis.com/auth/gmail.modifyhttps://www.googleapis.com/auth/gmail.composehttps://www.googleapis.com/auth/gmail.settings.basic

About Gmail

Gmail offers private and secure email by Google at no cost, for business and consumer accounts.

Action

Description:Creates a user with the given attributes. [See the documentation](https://support.miestro.com/article/279-api-documentation)
Version:0.0.1
Key:miestro-create-user

Miestro Overview

Miestro is a robust platform designed for creating and managing online courses. Leveraging the Miestro API on Pipedream allows you to automate interactions with your online courses, such as enrolling students, tracking progress, and analyzing engagement. With the automation workflows on Pipedream, you can streamline your educational platform's operations, react to student activity in real time, and integrate with other services to enhance the e-learning experience.

Action Code

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

export default {
  key: "miestro-create-user",
  version: "0.0.1",
  type: "action",
  name: "Create User",
  description: "Creates a user with the given attributes. [See the documentation](https://support.miestro.com/article/279-api-documentation)",
  props: {
    app,
    name: {
      type: "string",
      label: "Name",
      description: "Full name of the user",
    },
    email: {
      type: "string",
      label: "Email",
      description: "Email address of the user",
    },
    password: {
      type: "string",
      label: "Password",
      description: "Password of the account",
      secret: true,
    },
    role: {
      type: "string",
      label: "Role",
      description: "Role of the user",
      options: [
        {
          label: "User",
          value: "0",
        },
        {
          label: "Owner",
          value: "1",
        },
        {
          label: "Admin",
          value: "2",
        },
        {
          label: "Assistant",
          value: "3",
        },
        {
          label: "Support Specialist",
          value: "4",
        },
      ],
    },
  },
  async run ({ $ }) {
    const resp = await this.app.createUser({
      $,
      data: {
        name: this.name,
        email: this.email,
        password: this.password,
        role: this.role,
      },
    });
    $.export("$summary", `User(ID:${resp.id}) has been created successfully.`);
    return resp;
  },
};

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.

LabelPropTypeDescription
MiestroappappThis component uses the Miestro app.
Namenamestring

Full name of the user

Emailemailstring

Email address of the user

Passwordpasswordstring

Password of the account

RolerolestringSelect a value from the drop down menu:{ "label": "User", "value": "0" }{ "label": "Owner", "value": "1" }{ "label": "Admin", "value": "2" }{ "label": "Assistant", "value": "3" }{ "label": "Support Specialist", "value": "4" }

Action Authentication

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

To get your Miestro API Key and Secret, log into your Miestro account, click Settings from the menu on the left, then "API".

About Miestro

The ultimate course platform to help you easily your own online courses in just 5 steps.

More Ways to Connect Miestro + Gmail

Create User with Miestro API on New Labeled Email from Gmail API
Gmail + Miestro
 
Try it
Enroll User To Course with Miestro API on New Labeled Email from Gmail API
Gmail + Miestro
 
Try it
Unroll User To Course with Miestro API on New Labeled Email from Gmail API
Gmail + Miestro
 
Try it
Create User with Miestro API on New Sent Email from Gmail API
Gmail + Miestro
 
Try it
Enroll User To Course with Miestro API on New Sent Email from Gmail API
Gmail + Miestro
 
Try it
New Attachment Received from the Gmail API

Emit new event for each attachment in a message received. This source is capped at 100 max new messages per run.

 
Try it
New Email Matching Search from the Gmail API

Emit new event when an email matching the search criteria is received. This source is capped at 100 max new messages per run.

 
Try it
New Email Received from the Gmail API

Emit new event when a new email is received.

 
Try it
New Labeled Email from the Gmail API

Emit new event when a new email is labeled.

 
Try it
New Sent Email from the Gmail API

Emit new event for each new email sent. (Maximum of 100 events emited per execution)

 
Try it
Add Label to Email with the Gmail API

Add label(s) to an email message. See the docs

 
Try it
Create Draft with the Gmail API

Create a draft from your Google Workspace email account. See the documentation

 
Try it
Download Attachment with the Gmail API

Download an attachment by attachmentId to the /tmp directory. See the documentation

 
Try it
Find Email with the Gmail API

Find an email using Google's Search Engine. See the docs

 
Try it
Remove Label from Email with the Gmail API

Remove label(s) from an email message. See the docs

 
Try it

Explore Other Apps

1
-
24
of
2,200+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.