Search Businesses with Yelp API on New Contact from Vision6 API

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

Trigger workflow on

New Contact from the Vision6 API

Next, do this

Search Businesses with the Yelp 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 Vision6 trigger and Yelp 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 trigger
1. Connect your Vision6 account
2. Configure timer
3. Select a List
Configure the Search Businesses action
1. Connect your Yelp account
2. Optional- Configure Location
3. Optional- Configure Latitude
4. Optional- Configure Longitude
5. Optional- Configure Search Term
6. Optional- Configure Max Results
7. Optional- Configure Categories
8. Optional- Select one or more Price
9. Optional- Select one or more Attributes
10. Optional- Configure Additional Options
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 on Vision6

Description:Emit new event when a new contact is added

Version:0.0.2

Key:vision6-new-contact

View on GitHub

Vision6 Overview#

The Vision6 API offers a powerful way to automate email marketing and audience engagement directly through Pipedream. With it, you can programmatically manage lists, contacts, and messages, and also track campaign performance. This API provides granular control over email workflows, enabling custom triggers, targeted actions, and detailed analytics retrieval. The combination of Vision6 with Pipedream's serverless platform unlocks endless possibilities for syncing data, personalizing communication, and optimizing marketing strategies without manual intervention.

Trigger Code#

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

export default {
  ...common,
  key: "vision6-new-contact",
  name: "New Contact",
  description: "Emit new event when a new contact is added",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async getHistoricalEvents(limit) {
      const { _embedded: { contacts } } = await this.vision6.listContacts(this.list, {
        limit,
      });
      return contacts;
    },
    async getContacts(since = null) {
      return this.getPaginatedContacts(this.list, {
        ["creation_time:in"]: this.formatSinceDate(since),
      });
    },
    generateMeta(contact) {
      return {
        id: contact.id,
        summary: `New Contact ID: ${contact.id}`,
        ts: Date.parse(contact.creation_time),
      };
    },
  },
};

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
Vision6	`vision6`	`app`	This component uses the Vision6 app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
List	`list`	`integer`	Select a value from the drop down menu.

Trigger Authentication#

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

You can get your API Key and Region from the Integrations page in your Vision6 account, on the API Keys tab.
Your region is us1 if your Vision6 REST API Endpoint is https://us1.api.vision6.com/

About Vision6#

Australia's Most Reliable Email & SMS Marketing Software. Sign Up for a Free Trial Today!

Action#

Search Businesses on Yelp

Description:Search businesses matching given criteria [See docs here](https://docs.developer.yelp.com/reference/v3_business_search)

Version:0.0.1

Key:yelp-search-businesses

View on GitHub

Yelp Overview#

The Yelp API provides access to rich data on local businesses across various categories, including restaurants, bars, and service providers. Leveraging Yelp's API on Pipedream allows you to automate the retrieval of business information, ratings, and customer reviews, which can be instrumental in making data-driven decisions for market analysis, customer insights, or even personal use. By stitching the Yelp API into Pipedream workflows, you unlock potential for real-time monitoring, data collection, and cross-application synergy, enhancing your business intelligence and operational efficiency.

Action Code#

import { defineAction } from "@pipedream/types";
import yelp from "../../app/yelp.app.mjs";
import { ConfigurationError } from "@pipedream/platform";
import { ATTRIBUTE_OPTIONS, DOCS, PRICE_OPTIONS, } from "../../common/constants.mjs";
export default defineAction({
    name: "Search Businesses",
    description: `Search businesses matching given criteria [See docs here](${DOCS.searchBusinesses})`,
    key: "yelp-search-businesses",
    version: "0.0.1",
    type: "action",
    props: {
        yelp,
        location: {
            label: "Location",
            description: `The geographic area to be used when searching for businesses. Examples: "New York City", "NYC", "350 5th Ave, New York, NY 10118".
        \\
        Required if \`latitude\` and \`longitude\` are not provided.`,
            type: "string",
            optional: true,
        },
        latitude: {
            label: "Latitude",
            description: `Latitude of the location to search from.
        \\
        Required if \`location\` is not provided. If \`longitude\` is provided, latitude is required too.`,
            type: "string",
            optional: true,
        },
        longitude: {
            label: "Longitude",
            description: `Longitude of the location to search from.
        \\
        Required if \`location\` is not provided. If \`latitude\` is provided, longitude is required too.`,
            type: "string",
            optional: true,
        },
        term: {
            label: "Search Term",
            description: "Search term, e.g. \"food\" or \"restaurants\". The term may also be the business's name, such as \"Starbucks\". If term is not included, the action will default to searching across businesses from a small number of popular categories.",
            type: "string",
            optional: true,
        },
        maxResults: {
            label: "Max Results",
            description: "The maximum amount of businesses to be listed. Yelp enforces a limit of 1000. Default is 200.",
            type: "integer",
            max: 1000,
            default: 200,
            optional: true,
        },
        categories: {
            label: "Categories",
            description: `Categories to filter the search results with. [See the list of supported categories.](${DOCS.categories}) The category alias should be used (e.g. "discgolf", not "Disc Golf").`,
            type: "string[]",
            optional: true,
        },
        price: {
            label: "Price",
            description: "Pricing levels to filter the search result with.",
            type: "integer[]",
            optional: true,
            options: PRICE_OPTIONS,
        },
        attributes: {
            label: "Attributes",
            description: "Additional filters to return specific search results. If multiple attributes are used, only businesses that satisfy all the attributes will be returned.",
            type: "string[]",
            optional: true,
            options: ATTRIBUTE_OPTIONS,
        },
        additionalOptions: {
            label: "Additional Options",
            description: `Additional parameters to pass in the request, such as \`open_now\`. [See the docs for all the parameters.](${DOCS.searchBusinesses})`,
            type: "object",
            optional: true,
        },
    },
    async run({ $ }) {
        const { additionalOptions, attributes, categories, location, latitude, longitude, maxResults, price, term, } = this;
        if (!(location || (latitude && longitude))) {
            throw new ConfigurationError("Either `location`, or `latitude` and `longitude`, must be provided.");
        }
        const params = {
            $,
            params: {
                attributes: attributes?.join(),
                categories: categories?.join(),
                location,
                latitude,
                longitude,
                term,
                maxResults,
                price: price?.join(),
                ...additionalOptions,
            },
        };
        const response = await this.yelp.searchBusinesses(params);
        const { result: { length } } = response;
        const summary = length
            ? `Listed ${length} business${length === 1
                ? ""
                : "es"}`
            : "No businesses found with the given criteria";
        $.export("$summary", summary);
        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
Yelp	`yelp`	`app`	This component uses the Yelp app.
Location	`location`	`string`	The geographic area to be used when searching for businesses. Examples: "New York City", "NYC", "350 5th Ave, New York, NY 10118". Required if `latitude` and `longitude` are not provided.
Latitude	`latitude`	`string`	Latitude of the location to search from. Required if `location` is not provided. If `longitude` is provided, latitude is required too.
Longitude	`longitude`	`string`	Longitude of the location to search from. Required if `location` is not provided. If `latitude` is provided, longitude is required too.
Search Term	`term`	`string`	Search term, e.g. "food" or "restaurants". The term may also be the business's name, such as "Starbucks". If term is not included, the action will default to searching across businesses from a small number of popular categories.
Max Results	`maxResults`	`integer`	The maximum amount of businesses to be listed. Yelp enforces a limit of 1000. Default is 200.
Categories	`categories`	`string[]`	Categories to filter the search results with. See the list of supported categories. The category alias should be used (e.g. "discgolf", not "Disc Golf").
Price	`price`	`integer[]`	Select a value from the drop down menu:`{ "label": "$", "value": 1 }{ "label": "$$", "value": 2 }{ "label": "$$$", "value": 3 }{ "label": "$$$$", "value": 4 }`
Attributes	`attributes`	`string[]`	Select a value from the drop down menu:`{ "label": "Hot and New - popular businesses which recently joined Yelp", "value": "hot_and_new" }{ "label": "Request a Quote - businesses which actively reply to Request a Quote inquiries", "value": "request_a_quote" }{ "label": "Reservation - businesses with Yelp Reservations bookings enabled on their profile page", "value": "reservation" }{ "label": "Wait List Reservation - businesses with Yelp Wait List bookings enabled on their profile screen (iOS/Android)", "value": "waitlist_reservation" }{ "label": "Deals - businesses offering Yelp Deals on their profile page", "value": "deals" }{ "label": "Gender Neutral Restrooms - businesses which provide gender neutral restrooms", "value": "gender_neutral_restrooms" }{ "label": "Open to All - businesses which are Open To All", "value": "open_to_all" }{ "label": "Wheelchair Acessible - businesses which are Wheelchair Accessible", "value": "wheelchair_accessible" }`
Additional Options	`additionalOptions`	`object`	Additional parameters to pass in the request, such as `open_now`. See the docs for all the parameters.

Action Authentication#

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

To retrieve your API key for Yelp,

Navigate to your Yelp account and sign in
Go to “General” > “Manage App”

Search Businesses with Yelp API on New Contact from Vision6 API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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