Create Objects with Algolia API on New Complaint (Instant) from Mailgun API

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

Trigger workflow on

New Complaint (Instant) from the Mailgun API

Next, do this

Create Objects 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 Mailgun 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 Complaint (Instant) trigger
1. Connect your Mailgun account
2. Select a Domain Name
3. Configure Mailgun webhook signing key
Configure the Create Objects action
1. Connect your Algolia account
2. Select a Index Name
3. Configure Objects
4. Optional- Configure Auto Generate Object ID If Not Present
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 Complaint (Instant) on Mailgun

Description:Emit new event when the email recipient clicked on the spam complaint button within their email client. Feedback loops enable the notification to be received by Mailgun.

Version:0.0.2

Key:mailgun-new-complaint

View on GitHub

Mailgun Overview#

The Mailgun API on Pipedream is a potent tool for automating email operations without the overhead of managing a full-fledged email server. It offers capabilities to send, receive, track, and store emails with ease. With Pipedream's serverless platform, you can trigger workflows using Mailgun events, such as inbound emails or delivery status changes, and connect them to hundreds of other services to streamline communication, marketing, and notification systems within your ecosystem.

Trigger Code#

import common from "../common/http-based.mjs";

export default {
  ...common,
  key: "mailgun-new-complaint",
  name: "New Complaint (Instant)",
  type: "source",
  description: "Emit new event when the email recipient clicked on the spam complaint button within their email client. Feedback loops enable the notification to be received by Mailgun.",
  version: "0.0.2",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getEventName() {
      return [
        "complained",
      ];
    },
    getEventType() {
      return [
        "complained",
      ];
    },
    generateMeta(payload) {
      const id = payload.message.headers["message-id"];
      return {
        id: `${payload.id}${payload.timestamp}`,
        summary: `New Complaint on message ${id} by ${payload.recipient}`,
        ts: payload.timestamp,
      };
    },
  },
};

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
Mailgun	`mailgun`	`app`	This component uses the Mailgun app.
Domain Name	`domain`	`string`	Select a value from the drop down menu.
Mailgun webhook signing key	`webhookSigningKey`	`string`	Your Mailgun webhook signing key, found in your Mailgun dashboard, located under Settings on the left-hand nav and then in API Keys look for webhook signing key. Required to compute the authentication signature of events.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.

Trigger Authentication#

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

About Mailgun#

Mailgun is an email automation service built for developers. Powerful transactional email APIs enable you to send, receive, and track emails.

Action#

Create Objects on Algolia

Description:Adds an array of JavaScript objects to the given index. [See docs here](https://www.algolia.com/doc/api-reference/api-methods/save-objects/)

Version:0.0.3

Key:algolia-create-objects

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 algolia from "../../algolia.app.mjs";

export default {
  key: "algolia-create-objects",
  name: "Create Objects",
  description: "Adds an array of JavaScript objects to the given index. [See docs here](https://www.algolia.com/doc/api-reference/api-methods/save-objects/)",
  version: "0.0.3",
  type: "action",
  props: {
    algolia,
    indexName: {
      propDefinition: [
        algolia,
        "indexName",
      ],
    },
    objects: {
      label: "Objects",
      description: "An array of JavaScript objects, each corresponding to a new object in your search index. It's recommended you create this array of objects in a prior code step, then select expression mode and enter a variable reference to that array here",
      type: "string[]",
    },
    autoGenerateObjectIDIfNotExist: {
      type: "boolean",
      label: "Auto Generate Object ID If Not Present",
      description: "If an objectID property is not present on objects, automatically assign on. Defaults to true",
      optional: true,
      default: true,
    },
  },
  methods: {
    parseObject(object) {
      return (typeof object === "object")
        ? object
        : JSON.parse(object);
    },
  },
  async run({ $ }) {
    const parsedObjects = this.objects.length
      ? this.objects.map((object) => this.parseObject(object))
      : this.parseObject(this.objects);

    const response = await this.algolia.createObjects({
      indexName: this.indexName,
      objects: parsedObjects,
      options: {
        autoGenerateObjectIDIfNotExist: this.autoGenerateObjectIDIfNotExist,
      },
    });

    $.export("$summary", "Successfully created objects");

    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	`algolia`	`app`	This component uses the Algolia app.
Index Name	`indexName`	`string`	Select a value from the drop down menu.
Objects	`objects`	`string[]`	An array of JavaScript objects, each corresponding to a new object in your search index. It's recommended you create this array of objects in a prior code step, then select expression mode and enter a variable reference to that array here
Auto Generate Object ID If Not Present	`autoGenerateObjectIDIfNotExist`	`boolean`	If an objectID property is not present on objects, automatically assign on. Defaults to true

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.

About Algolia#

Algolia helps businesses across industries quickly create relevant, scalable, and lightning fast Search and Discovery experiences.

More Ways to Connect Algolia + Mailgun#

Other Popular Integrations#

Create Objects with Algolia API on New Bounce from Mailgun API

Mailgun + Algolia

Create Objects with Algolia API on New Complaint (Instant) from Mailgun API

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

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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