Browse Records with Algolia API on New Alert from New Relic API

Pipedream makes it easy to connect APIs for Algolia, New Relic and 2,500+ other apps remarkably fast.

Trigger workflow on

New Alert from the New Relic API

Next, do this

Browse Records with the Algolia 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 New Relic trigger and Algolia action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Alert trigger
1. Connect your New Relic account
2. Configure Polling interval
3. Optional- Configure Product
4. Optional- Configure Entity Type
5. Optional- Configure Entity Group ID
6. Optional- Configure Entity ID
7. Optional- Configure Event Type
8. Optional- Configure Incident ID
Configure the Browse Records action
1. Connect your Algolia account
2. Select a Index Name
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 Alert on New Relic

Description:Emit new event when a new alert is created.

Version:0.0.2

Key:new_relic-new-alert

View on GitHub

New Relic Overview#

The New Relic API offers powerful capabilities for monitoring, alerting, and analyzing the performance of your web applications and infrastructure. By using the API within Pipedream, you can automate and orchestrate a vast array of operations that revolve around your application's health and data insights. This can range from triggering workflows based on New Relic alerts, to syncing performance data with other tools, or even automating responses to specific incidents.

Trigger Code#

import common from "../../common/common-sources.mjs";

export default {
  dedupe: "unique",
  type: "source",
  key: "new_relic-new-alert",
  name: "New Alert",
  description: "Emit new event when a new alert is created.",
  version: "0.0.2",
  props: {
    ...common.props,
    product: {
      label: "Product",
      description: "Filter by New Relic product",
      type: "string",
      optional: true,
    },
    entityType: {
      label: "Entity Type",
      description: "Filter by entity type",
      type: "string",
      optional: true,
    },
    entityGroupId: {
      label: "Entity Group ID",
      description: "Filter by entity group ID",
      type: "string",
      optional: true,
    },
    entityId: {
      label: "Entity ID",
      description: "Filter by entity ID",
      type: "string",
      optional: true,
    },
    eventType: {
      label: "Event Type",
      description: "Filter by event type",
      type: "string",
      optional: true,
    },
    incidentId: {
      label: "Incident ID",
      description: "Filter by incident ID",
      type: "string",
      optional: true,
    },
  },
  methods: {
    _setLastEmittedAlert(deployment) {
      this.db.set("lastEmittedAlert", deployment);
    },
    _getLastEmittedAlert() {
      return this.db.get("lastEmittedAlert");
    },
    getMeta({
      id,
      description,
      timestamp,
    }) {
      return {
        id,
        summary: description,
        ts: new Date(timestamp),
      };
    },
  },
  async run () {
    const params = {
      product: this.product,
      entity_type: this.entityType,
      entity_group_id: this.entityGroupId,
      entity_id: this.entityId,
      event_type: this.eventType,
      incident_id: this.incidentId,
    };
    const alerts = await this.app.listAlerts(params);
    const toEmitEvents = [];
    const prevRequestFirstItem = this._getLastEmittedAlert();
    for (const alert of alerts) {
      if (prevRequestFirstItem == alert.id) {
        break;
      }
      toEmitEvents.unshift(alert);
    }
    this._setLastEmittedAlert(alerts[0].id);

    for (const alert of toEmitEvents) {
      this.$emit(alert, this.getMeta(alert));
    }
  },
};

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
New Relic	`app`	`app`	This component uses the New Relic app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	How often to poll the New Relic for new events
Product	`product`	`string`	Filter by New Relic product
Entity Type	`entityType`	`string`	Filter by entity type
Entity Group ID	`entityGroupId`	`string`	Filter by entity group ID
Entity ID	`entityId`	`string`	Filter by entity ID
Event Type	`eventType`	`string`	Filter by event type
Incident ID	`incidentId`	`string`	Filter by incident ID

Trigger Authentication#

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

New Relic API calls require an API key in the call header. The API key uniquely identifies your account and authorizes access to your account data. Find your API key in your account settings > integrations > api key.

About New Relic#

Real-time performance insights into your software, infrastructure & customer experience

Action#

Browse Records on Algolia

Description:Browse for records in the given index. [See the documentation](https://www.algolia.com/doc/libraries/javascript/v5/methods/search/browse/?client=javascript).

Version:0.0.1

Key:algolia-browse-records

View on GitHub

Algolia Overview#

Algolia is a powerful search-as-a-service platform that makes it easy to deliver fast, relevant search experiences to users. The Algolia API allows developers to programmatically manage search indices, perform searches, and capture insights about search activity. With Pipedream, you can harness this API to automate and integrate Algolia's capabilities with other apps, creating efficient workflows that enhance search functionalities and user engagement. You can sync data across platforms, automate content indexing, and trigger actions based on search patterns or user behaviors.

Action Code#

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

export default {
  key: "algolia-browse-records",
  name: "Browse Records",
  description: "Browse for records in the given index. [See the documentation](https://www.algolia.com/doc/libraries/javascript/v5/methods/search/browse/?client=javascript).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    indexName: {
      propDefinition: [
        app,
        "indexName",
      ],
    },
  },
  methods: {
    browse(args) {
      return this.app._client().browse(args);
    },
  },
  async run({ $ }) {
    const {
      browse,
      indexName,
    } = this;

    const response = await browse({
      indexName,
    });

    $.export("$summary", `Successfully fetched records from ${indexName} index.`);

    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
Algolia	`app`	`app`	This component uses the Algolia app.
Index Name	`indexName`	`string`	Select a value from the drop down menu.

Action Authentication#

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

In your Algolia Dashboard, select the API Keys section. Here you'll find your Application ID and API Keys. You can use either your Admin API Key or create another API key with permissions scoped to a specific index / operations (recommended).

Once done, enter both values below.