Upload File with Autodesk API on New Requests from HTTP / Webhook API

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

Trigger workflow on

New Requests from the HTTP / Webhook API

Next, do this

Upload File with the Autodesk 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 Autodesk 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 Upload File action
1. Connect your Autodesk account
2. Select a Hub ID
3. Select a Project
4. Select a Folder ID
5. Configure File Name
6. Configure File Path
7. Optional- Select a Extension Type
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#

Upload File on Autodesk

Description:Uploads a new file to a specified folder in Autodesk. [See the documentation](https://aps.autodesk.com/en/docs/data/v2/tutorials/upload-file/).

Version:0.0.1

Key:autodesk-upload-file

View on GitHub

Action Code#

import autodesk from "../../autodesk.app.mjs";
import { axios } from "@pipedream/platform";
import fs from "fs";

export default {
  key: "autodesk-upload-file",
  name: "Upload File",
  description: "Uploads a new file to a specified folder in Autodesk. [See the documentation](https://aps.autodesk.com/en/docs/data/v2/tutorials/upload-file/).",
  version: "0.0.1",
  type: "action",
  props: {
    autodesk,
    hubId: {
      propDefinition: [
        autodesk,
        "hubId",
      ],
    },
    projectId: {
      propDefinition: [
        autodesk,
        "projectId",
        (c) => ({
          hubId: c.hubId,
        }),
      ],
    },
    folderId: {
      propDefinition: [
        autodesk,
        "folderId",
        (c) => ({
          hubId: c.hubId,
          projectId: c.projectId,
        }),
      ],
    },
    fileName: {
      type: "string",
      label: "File Name",
      description: "The name of the file to upload",
    },
    filePath: {
      type: "string",
      label: "File Path",
      description: "The path to a file in the `/tmp` directory. [See the documentation on working with files](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp)",
    },
    type: {
      type: "string",
      label: "Extension Type",
      description: "The type of file extension. For BIM 360 Docs files, use `items:autodesk.bim360:File`. For all other services, use `items:autodesk.core:File`.",
      options: [
        {
          label: "BIM 360 Docs files",
          value: "items:autodesk.core:File",
        },
        {
          label: "Other files",
          value: "items:autodesk.bim360:File",
        },
      ],
      default: "items:autodesk.core:File",
      optional: true,
    },
  },
  async run({ $ }) {
    // Create storage location
    const { data } = await this.autodesk.createStorageLocation({
      $,
      projectId: this.projectId,
      data: {
        jsonapi: {
          version: "1.0",
        },
        data: {
          type: "objects",
          attributes: {
            name: this.fileName,
          },
          relationships: {
            target: {
              data: {
                type: "folders",
                id: this.folderId,
              },
            },
          },
        },
      },
    });

    const objectId = data.id;
    const [
      bucketKey,
      objectKey,
    ] = objectId.split("os.object:")[1]?.split("/") || [];

    // Generate signed URL
    const {
      urls, uploadKey,
    } = await this.autodesk.generateSignedUrl({
      $,
      bucketKey,
      objectKey,
    });

    const signedUrl = urls[0];

    // Upload to signed URL
    const filePath = this.filePath.includes("tmp/")
      ? this.filePath
      : `/tmp/${this.filePath}`;
    const fileStream = fs.createReadStream(filePath);
    const fileSize = fs.statSync(filePath).size;

    await axios($, {
      url: signedUrl,
      data: fileStream,
      method: "PUT",
      headers: {
        "Content-Type": "application/octet-stream",
        "Content-Length": fileSize,
      },
      maxContentLength: Infinity,
      maxBodyLength: Infinity,
    });

    // Complete the upload
    await this.autodesk.completeUpload({
      $,
      bucketKey,
      objectKey,
      data: {
        uploadKey,
      },
    });

    // Create version 1.0 of uploaded file
    const response = await this.autodesk.createFirstVersionOfFile({
      $,
      projectId: this.projectId,
      data: {
        jsonapi: {
          version: "1.0",
        },
        data: {
          type: "items",
          attributes: {
            displayName: this.fileName,
            extension: {
              type: this.type,
              version: "1.0",
            },
          },
          relationships: {
            tip: {
              data: {
                type: "versions",
                id: "1",
              },
            },
            parent: {
              data: {
                type: "folders",
                id: this.folderId,
              },
            },
          },
        },
        included: [
          {
            type: "versions",
            id: "1",
            attributes: {
              name: this.fileName,
              extension: {
                type: this.type.replace("items", "versions"),
                version: "1.0",
              },
            },
            relationships: {
              storage: {
                data: {
                  type: "objects",
                  id: objectId,
                },
              },
            },
          },
        ],
      },
    });

    $.export("$summary", `Successfully uploaded file ${this.fileName}`);
    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
Autodesk	`autodesk`	`app`	This component uses the Autodesk app.
Hub ID	`hubId`	`string`	Select a value from the drop down menu.
Project	`projectId`	`string`	Select a value from the drop down menu.
Folder ID	`folderId`	`string`	Select a value from the drop down menu.
File Name	`fileName`	`string`	The name of the file to upload
File Path	`filePath`	`string`	The path to a file in the `/tmp` directory. See the documentation on working with files
Extension Type	`type`	`string`	Select a value from the drop down menu:`{ "label": "BIM 360 Docs files", "value": "items:autodesk.core:File" }{ "label": "Other files", "value": "items:autodesk.bim360:File" }`

Action Authentication#

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

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

data:read data:create

About Autodesk#

3D Design, Engineering & Construction Software

More Ways to Connect Autodesk + HTTP / Webhook#

Other Popular Integrations#

Create Folder with Autodesk API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Autodesk