← HTTP / Webhook + Box integrations

Search Content with Box API on New Requests (Payload Only) from HTTP / Webhook API

Pipedream makes it easy to connect APIs for Box, HTTP / Webhook and 900+ other apps remarkably fast.

Trigger workflow on
New Requests (Payload Only) from the HTTP / Webhook API
Next, do this
Search Content with the Box API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

This integration creates a workflow with a HTTP / Webhook trigger and Box action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Select this integration
  2. Configure the New Requests (Payload Only) trigger
    1. Connect your HTTP / Webhook account
  3. Configure the Search Content action
    1. Connect your Box account
    2. Optional- Select a Type
    3. Optional- Configure Query
    4. Optional- Configure Metadata Filters
    5. Optional- Configure Fields
  4. Deploy the workflow
  5. Send a test event to validate your setup
  6. Turn on the trigger

Details

This integration uses pre-built, open source 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

Description:Get a URL and emit the HTTP body as an event on every request
Version:0.1.1
Key:http-new-requests-payload-only

Trigger Code

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

// Core HTTP component
// Returns a 200 OK response, emits the HTTP payload as an event
export default {
  key: "http-new-requests-payload-only",
  name: "New Requests (Payload Only)",
  // eslint-disable-next-line
  description: "Get a URL and emit the HTTP body as an event on every request",
  version: "0.1.1",
  type: "source",
  props: {
    // eslint-disable-next-line
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    http,
  },
  async run(event) {
    const { body } = event;
    this.httpInterface.respond({
      status: 200,
      body,
    });
    // Emit the HTTP payload
    this.$emit({
      body,
    });
  },
};

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.
LabelPropTypeDescription
N/AhttpInterface$.interface.httpThis 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.
HTTP / WebhookhttpappThis 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

Description:Searches for files, folders, web links, and shared files across the users content or across the entire enterprise. [See the docs here](https://developer.box.com/reference/get-search/).
Version:0.0.1
Key:box-search-content

Action Code

import app from "../../box.app.mjs";
import { ConfigurationError } from "@pipedream/platform";
import utils from "../../common/utils.mjs";

export default {
  name: "Search Content",
  description: "Searches for files, folders, web links, and shared files across the users content or across the entire enterprise. [See the docs here](https://developer.box.com/reference/get-search/).",
  key: "box-search-content",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    searchType: {
      propDefinition: [
        app,
        "searchType",
      ],
    },
    query: {
      propDefinition: [
        app,
        "query",
      ],
    },
    mdfilters: {
      propDefinition: [
        app,
        "mdfilters",
      ],
    },
    fields: {
      propDefinition: [
        app,
        "fields",
      ],
    },
  },
  async run({ $ }) {
    const results = [];
    if (!this.query && !this.mdfilters) {
      throw new ConfigurationError("At least one of `Query` and `Metadata Filters` props is needed.");
    }
    const resourcesStream = await utils.getResourcesStream({
      resourceFn: this.app.searchContent,
      resourceFnArgs: {
        $,
        params: {
          query: this.query,
          mdfilters: this.mdfilters,
          type: this.searchType,
          fields: this.fields,
        },
      },
    });
    for await (const resource of resourcesStream) {
      results.push(resource);
    }
    // eslint-disable-next-line multiline-ternary
    $.export("$summary", results.length ? `Successfully fetched ${results.length} search result${results.length === 1 ? "" : "s"}.` : "No search results.");
    return results;
  },
};

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.

LabelPropTypeDescription
BoxappappThis component uses the Box app.
TypesearchTypestringSelect a value from the drop down menu:{ "label": "Files", "value": "file" }{ "label": "Folders", "value": "folder" }{ "label": "Web Links", "value": "web_link" }
Queryquerystring

The string to search for. This query is matched against item names, descriptions, text content of files, and various other fields of the different item types. Please see the docs

Metadata Filtersmdfiltersstring

A list of metadata templates to filter the search results by. e.g. [{"scope":"enterprise","templateKey":"contract","filters":{"category":"online"}}]. Please see the docs

Fieldsfieldsstring[]

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response, e.g. id,type,name

Action Authentication

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

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

About Box

Platform for secure content management, workflow, and collaboration

More Ways to Connect Box + HTTP / Webhook

Search Content with Box API on New Requests from HTTP / Webhook API
HTTP / Webhook + Box
 
Try it
Upload a File with Box API on New Requests from HTTP / Webhook API
HTTP / Webhook + Box
 
Try it
Upload a File with Box API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Box
 
Try it
Send any HTTP Request with HTTP / Webhook API on New Event from Box API
Box + HTTP / Webhook
 
Try it
Send any HTTP Request with HTTP / Webhook API on New File Event from Box API
Box + HTTP / Webhook
 
Try it
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
New Event from the Box API

Emit new event when an event with subscribed event source triggered on a target, See the docs

 
Try it
New File Event from the Box API

Emit new event when a new file uploaded on a target, See the docs

 
Try it
Send any HTTP Request with the HTTP / Webhook API

Send an HTTP request using any method and URL. Optionally configure query string parameters, headers, and basic auth.

 
Try it
Send GET Request with the HTTP / Webhook API

Send an HTTP GET request to any URL. Optionally configure query string parameters, headers and basic auth.

 
Try it
Send POST Request with the HTTP / Webhook API

Send an HTTP POST request to any URL. Optionally configure query string parameters, headers and basic auth.

 
Try it
Send PUT Request with the HTTP / Webhook API

Send an HTTP PUT request to any URL. Optionally configure query string parameters, headers and basic auth.

 
Try it
Return HTTP Response with the HTTP / Webhook API

Use with an HTTP Source that uses Return a custom response from your workflow as its HTTP Response

 
Try it