Get Alert Status with Opsgenie API on New Field in Document from MongoDB API

Pipedream makes it easy to connect APIs for Opsgenie, MongoDB and 2,400+ other apps remarkably fast.

Trigger workflow on

New Field in Document from the MongoDB API

Next, do this

Get Alert Status with the Opsgenie 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 MongoDB trigger and Opsgenie action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Field in Document trigger
1. Connect your MongoDB account
2. Configure Polling Interval
3. Select a Database
4. Select a Collection
5. Select a Document
Configure the Get Alert Status action
1. Connect your Opsgenie account
2. Configure Request ID
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 Field in Document on MongoDB

Description:Emit new an event when a new field is added to a document

Version:0.0.7

Key:mongodb-new-field-in-document

View on GitHub

MongoDB Overview#

The MongoDB API provides powerful capabilities to interact with a MongoDB database, allowing you to perform CRUD (Create, Read, Update, Delete) operations, manage databases, and execute sophisticated queries. With Pipedream, you can harness these abilities to automate tasks, sync data across various apps, and react to events in real-time. It’s a combo that’s particularly potent for managing data workflows, syncing application states, or triggering actions based on changes to your data.

Trigger Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "mongodb-new-field-in-document",
  name: "New Field in Document",
  description: "Emit new an event when a new field is added to a document",
  version: "0.0.7",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    database: {
      propDefinition: [
        common.props.mongodb,
        "database",
      ],
    },
    collection: {
      propDefinition: [
        common.props.mongodb,
        "collection",
        (c) => ({
          database: c.database,
        }),
      ],
    },
    document: {
      propDefinition: [
        common.props.mongodb,
        "document",
        (c) => ({
          database: c.database,
          collection: c.collection,
        }),
      ],
    },
  },
  methods: {
    ...common.methods,
    _getFields() {
      return this.db.get("fields");
    },
    _setFields(fields) {
      this.db.set("fields", fields);
    },
    isRelevant(key, fields) {
      return !fields.includes(key);
    },
    async processEvent(client, ts) {
      const fields = this._getFields() || [];
      const collection = this.mongodb.getCollection(client, this.database, this.collection);
      const documents = await this.mongodb.listDocuments(collection);
      const doc = documents.find((obj) => {
        return obj._id == this.document;
      });
      const keys = Object.keys(doc);
      for (const key of keys) {
        if (!this.isRelevant(key, fields)) {
          continue;
        }
        fields.push(key);
        this.emitEvent(key, ts);
      }
      this._setFields(fields);
    },
    generateMeta(key, ts) {
      return {
        id: key,
        summary: `New Field ${key}`,
        ts,
      };
    },
  },
};

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
MongoDB	`mongodb`	`app`	This component uses the MongoDB app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling Interval	`timer`	`$.interface.timer`	Pipedream will poll the API on this schedule
Database	`database`	`string`	Select a value from the drop down menu.
Collection	`collection`	`string`	Select a value from the drop down menu.
Document	`document`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

Before you connect to your Mongo database from Pipedream, please make sure your database is accessible from the public internet. You may need to add a firewall rule allowing connections from 0.0.0.0/0.

Then, enter the details of your Mongo host / database below.

About MongoDB#

MongoDB is an open source NoSQL database management program.

Action#

Get Alert Status on Opsgenie

Description:Get the status of the alert with the specified ID. [See the documentation](https://www.postman.com/api-evangelist/opsgenie/request/03tcghu/get-request-status-of-alert)

Version:0.0.1

Key:opsgenie-get-alert-status

View on GitHub

Opsgenie Overview#

The Opsgenie API enables automated incident management and alerting to streamline response actions. It allows you to create, update, and manage alerts, as well as configure and query users, schedules, and on-call rotations. Integrating Opsgenie with Pipedream opens up possibilities for orchestrating complex workflows, such as incident triggering from various sources, auto-update of tickets, synchronization with other tools, and much more, all in a serverless environment.

Action Code#

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

export default {
  key: "opsgenie-get-alert-status",
  name: "Get Alert Status",
  description: "Get the status of the alert with the specified ID. [See the documentation](https://www.postman.com/api-evangelist/opsgenie/request/03tcghu/get-request-status-of-alert)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    requestId: {
      propDefinition: [
        app,
        "requestId",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.app.getAlertStatus({
      $,
      requestId: this.requestId,
    });

    $.export("$summary", `Request processing status: '${response.data.status}'`);

    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
Opsgenie	`app`	`app`	This component uses the Opsgenie app.
Request ID	`requestId`	`string`	ID of the alert request to be checked

Action Authentication#

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

Opsgenie uses two sets of API Keys for different purposes - the Global API Key is primarily used for global configuration management, and the Team API Key is tied directly to a given team. To learn about the difference between Global API Key and Team API Key, see the docs here.

Please note, that you will need to provide your Team API Key to Create Alert, Acknowledge Alert, or Close Alert as those API calls are restricted to Team API Keys.