Search Businesses with Yelp API on New Requests from HTTP / Webhook API

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

Trigger workflow on

New Requests from the HTTP / Webhook 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 HTTP / Webhook 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 Requests trigger
1. Optional- Configure Body Only
2. Optional- Configure Response Status Code
3. Optional- Configure Response Content-Type
4. Optional- Configure Response Body
5. Connect your HTTP / Webhook account
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 Requests on HTTP / Webhook

Description:Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.

Version:0.1.1

Key:http-new-requests

View on GitHub

HTTP / Webhook Overview#

Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.

Point and click HTTP requests

Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

Focus on integrating, not authenticating

This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.

Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.

Compatible with no code actions or Node.js and Python

The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.

Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.

Trigger Code#

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

// Core HTTP component
export default {
  key: "http-new-requests",
  name: "New Requests",
  description: "Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.",
  version: "0.1.1",
  type: "source",
  props: {
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    emitBodyOnly: {
      type: "boolean",
      label: "Body Only",
      description: "This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.",
      optional: true,
      default: false,
    },
    resStatusCode: {
      type: "string",
      label: "Response Status Code",
      description: "The status code to return in the HTTP response",
      optional: true,
      default: "200",
    },
    resContentType: {
      type: "string",
      label: "Response Content-Type",
      description: "The `Content-Type` of the body returned in the HTTP response",
      optional: true,
      default: "application/json",
    },
    resBody: {
      type: "string",
      label: "Response Body",
      description: "The body to return in the HTTP response",
      optional: true,
      default: "{ \"success\": true }",
    },
    http,
  },
  async run(event) {
    const summary = `${event.method} ${event.path}`;

    this.httpInterface.respond({
      status: this.resStatusCode,
      body: this.resBody,
      headers: {
        "content-type": this.resContentType,
      },
    });

    if (this.emitBodyOnly) {
      this.$emit(event.body, {
        summary,
      });
    } else {
      this.$emit(event, {
        summary,
      });
    }
  },
};

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
N/A	`httpInterface`	`$.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.
Body Only	`emitBodyOnly`	`boolean`	This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.
Response Status Code	`resStatusCode`	`string`	The status code to return in the HTTP response
Response Content-Type	`resContentType`	`string`	The `Content-Type` of the body returned in the HTTP response
Response Body	`resBody`	`string`	The body to return in the HTTP response
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.

Trigger Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

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”

About Yelp#

Connecting people with great local businesses.

More Ways to Connect Yelp + HTTP / Webhook#

Other Popular Integrations#

Get Business Details with Yelp API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Yelp

Try it

Get Business Details with Yelp API on New Requests from HTTP / Webhook API

HTTP / Webhook + Yelp

Try it

List Business Reviews with Yelp API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Yelp

Try it

List Business Reviews with Yelp API on New Requests from HTTP / Webhook API

HTTP / Webhook + Yelp

Try it

Search Businesses By Phone Number with Yelp API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Yelp

Try it

Popular Triggers#

New Requests from the HTTP / Webhook API

Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.

Try it

New Requests (Payload Only) from the HTTP / Webhook API

Get a URL and emit the HTTP body as an event on every request

Try it

New event when the content of the URL changes. from the HTTP / Webhook API

Emit new event when the content of the URL changes.

Try it