Search Collection with Needle API on New Event Triggered (Instant) from Easyly API

Pipedream makes it easy to connect APIs for Needle, Easyly and 2,700+ other apps remarkably fast.

Trigger workflow on

New Event Triggered (Instant) from the Easyly API

Next, do this

Search Collection with the Needle 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 Easyly trigger and Needle action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Event Triggered (Instant) trigger
1. Connect your Easyly account
Configure the Search Collection action
1. Connect your Needle account
2. Select a Collection ID
3. Configure Search Query
4. Optional- Configure Maximum Similarity Distance
5. Optional- Configure Maximum Number Of Results
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 Event Triggered (Instant) on Easyly

Description:Emit new event when an action is triggered in network leads. After creating the source, you need to [register a Webhook on Easyly](https://app.easyly.com/settings/developers) using the source's HTTP Endpoint. [See the documentation](https://api.easyly.com/webhooks)

Version:0.0.1

Key:easyly-new-event-triggered-instant

View on GitHub

Easyly Overview#

The Easyly API offers a suite of features aimed at simplifying complex tasks such as address validation, geocoding, and route optimization. With Pipedream's serverless platform, you can leverage this API to automate workflows that require address verification, coordinate mapping, or efficient route planning. The integration of Easyly with Pipedream allows you to set up triggers and actions without setting up a server, making it straightforward to incorporate real-time data processing and event-driven architectures into your applications.

Trigger Code#

import { v4 as uuid } from "uuid";
import app from "../../easyly.app.mjs";

export default {
  key: "easyly-new-event-triggered-instant",
  name: "New Event Triggered (Instant)",
  description: "Emit new event when an action is triggered in network leads. After creating the source, you need to [register a Webhook on Easyly](https://app.easyly.com/settings/developers) using the source's HTTP Endpoint. [See the documentation](https://api.easyly.com/webhooks)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    app,
    http: "$.interface.http",
  },
  async run(event) {
    const { body } = event;
    const eventType = body.type;

    this.$emit(body, {
      id: uuid(),
      summary: `New Event: ${eventType}`,
      ts: Date.now(),
    });
  },
};

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
Easyly	`app`	`app`	This component uses the Easyly 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.

Trigger Authentication#

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

About Easyly#

Easyly Cloud-based CRM software for streamlined sales, marketing, and everyday tasks with customizable workflows.

Action#

Search Collection on Needle

Description:Search a collection for relevant data chunks based on a query. [See the documentation](https://docs.needle-ai.com/docs/api-reference/search-collection/).

Version:0.0.1

Key:needle-search-collection

View on GitHub

Action Code#

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

export default {
  key: "needle-search-collection",
  name: "Search Collection",
  description: "Search a collection for relevant data chunks based on a query. [See the documentation](https://docs.needle-ai.com/docs/api-reference/search-collection/).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    collectionId: {
      propDefinition: [
        app,
        "collectionId",
      ],
    },
    text: {
      type: "string",
      label: "Search Query",
      description: "The text to search for in the collection.",
    },
    maxDistance: {
      type: "string",
      label: "Maximum Similarity Distance",
      description: "Maximum similarity distance for the search results, between `0` and `1`. Eg. `0.65`.",
      optional: true,
    },
    topK: {
      type: "integer",
      label: "Maximum Number Of Results",
      description: "The maximum number of search results to return.",
      optional: true,
    },
  },
  methods: {
    searchCollection({
      collectionId, ...args
    } = {}) {
      return this.app.post({
        subdomain: "search.",
        path: `/collections/${collectionId}/search`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      searchCollection,
      collectionId,
      text,
      maxDistance,
      topK,
    } = this;

    const response = await searchCollection({
      $,
      collectionId,
      data: {
        text,
        max_distance: maxDistance,
        top_k: topK,
      },
    });

    $.export("$summary", "Successfully searched the collection.");

    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
Needle	`app`	`app`	This component uses the Needle app.
Collection ID	`collectionId`	`string`	Select a value from the drop down menu.
Search Query	`text`	`string`	The text to search for in the collection.
Maximum Similarity Distance	`maxDistance`	`string`	Maximum similarity distance for the search results, between `0` and `1`. Eg. `0.65`.
Maximum Number Of Results	`topK`	`integer`	The maximum number of search results to return.