Browse Records with Algolia API on New Contact Created from Microsoft 365 People API

Pipedream makes it easy to connect APIs for Algolia, Microsoft 365 People and 2,700+ other apps remarkably fast.

Trigger workflow on

New Contact Created from the Microsoft 365 People 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 Microsoft 365 People 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 Contact Created trigger
1. Connect your Microsoft 365 People account
2. Configure Webhook renewal timer
3. Optional- Select a Folder
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 Contact Created on Microsoft 365 People

Description:Emit new event when a new contact is created in a folder.

Version:0.0.1

Key:microsoft_365_people-new-contact-created

View on GitHub

Microsoft 365 People Overview#

The Microsoft 365 People API lets you tap into your organization's contact data, providing access to people's info within your Microsoft 365 domain. With this API, you can search for users and contacts, discover relationships, and construct rich profiles that include contact information, organizational hierarchies, and photo URLs. On Pipedream, you can harness this API to automate contact management tasks, enhance CRM data, or trigger actions based on changes in your organization's personnel.

Trigger Code#

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

export default {
  ...common,
  key: "microsoft_365_people-new-contact-created",
  name: "New Contact Created",
  description: "Emit new event when a new contact is created in a folder.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    folderId: {
      propDefinition: [
        common.props.microsoftOutlook,
        "folderId",
      ],
    },
  },
  hooks: {
    ...common.hooks,
    async activate() {
      await this.activate({
        changeType: "created",
        resource: this.folderId
          ? `/me/contactFolders/${this.folderId}/contacts`
          : "/me/contacts",
      });
    },
    async deactivate() {
      await this.deactivate();
    },
  },
  methods: {
    ...common.methods,
    async getSampleEvents() {
      return this.folderId
        ? this.microsoftOutlook.listContactsInFolder({
          folderId: this.folderId,
        })
        : this.microsoftOutlook.listContacts();
    },
    generateMeta(item) {
      return {
        id: item.id.slice(-64),
        summary: `${item.displayName}` || `${item.id}`,
        ts: Date.parse(item.createdDateTime),
      };
    },
  },
  async run(event) {
    await this.run({
      event,
      emitFn: async ({ resourceId } = {}) => {
        const item = await this.microsoftOutlook.getContact({
          contactId: resourceId,
        });
        this.emitEvent(item);
      },
    });
  },
};

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
Microsoft 365 People	`microsoftOutlook`	`app`	This component uses the Microsoft 365 People app.
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Webhook renewal timer	`timer`	`$.interface.timer`	Graph API expires Outlook notifications in 3 days, we auto-renew them in 2 days, see
Folder	`folderId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

Contacts.ReadWriteUser.Reademailoffline_accessopenidprofile

About Microsoft 365 People#

Create, view, and edit contacts, contact lists, and groups in your Microsoft 365 account.

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.