Skip to main content

Autodesk Platform Services Webhooks

TL;DR

To integrate Autodesk Platform Services webhooks with ngrok:

  1. Launch your local webhook. npm start
  2. Launch ngrok. ngrok http 3000
  3. Configure Autodesk webhooks with your ngrok URL.
  4. Secure your webhook requests with verification.

This guide covers how to use ngrok to integrate your localhost app with Autodesk Platform Services by using Webhooks. Autodesk Platform Services webhooks can be used to notify an external application whenever specific events occur in your Autodesk account.

By integrating ngrok with Autodesk, you can:

  • Develop and test Autodesk webhooks locally, eliminating the time in deploying your development code to a public environment and setting it up in HTTPS.
  • Inspect and troubleshoot requests from Autodesk in real-time via the inspection UI and API.
  • Modify and Replay Autodesk Webhook requests with a single click and without spending time reproducing events manually in your Autodesk account.
  • Secure your app with Autodesk validation provided by ngrok. Invalid requests are blocked by ngrok before reaching your app.

Step 1: Start your app​

For this tutorial, we'll use the sample NodeJS app available on GitHub.

To install this sample, run the following commands in a terminal:

git clone https://github.com/ngrok/ngrok-webhook-nodejs-sample.git
cd ngrok-webhook-nodejs-sample
npm install

This will get the project installed locally.

Now you can launch the app by running the following command:

npm start

The app runs by default on port 3000.

You can validate that the app is up and running by visiting http://localhost:3000. The application logs request headers and body in the terminal and responds with a message in the browser.

Step 2: Launch ngrok​

Once your app is running successfully on localhost, let's get it on the internet securely using ngrok!

  1. If you're not an ngrok user yet, just sign up for ngrok for free.

  2. Download the ngrok agent.

  3. Go to the ngrok dashboard and copy your Authtoken.
    Tip: The ngrok agent uses the auth token to log into your account when you start a tunnel.

  4. Start ngrok by running the following command:

    ngrok http 3000

  5. ngrok will display a URL where your localhost application is exposed to the internet (copy this URL for use with Autodesk). ngrok agent running

Step 3: Integrate Autodesk​

To register a webhook on your Autodesk account follow the instructions below:

  1. Access Autodesk Platform Services and sign in using your Autodesk account.

  2. On the Platform Services page, click your avatar icon on the top-right corner of the page, click Applications, click Create Application, enter a name in the Name field, and then click Create.

  3. In the Client Credentials section of your application page, copy the values of the Client ID and the Client Secret fields for later use.
    Tip: Click the eye icon to reveal the Client Secret value to copy or click the copy icon.

  4. In the General Settings section, enter the URL provided by the ngrok agent to expose your application to the internet in the Callback URL field (i.e. https://1a2b-3c4d-5e6f-7g8h-9i0j.sa.ngrok.io). Callback URL

  5. In the API Access section, select the Data Management API and the Webhooks API from the list, and then click Save changes.
    Tip: This tutorial uses the Data Management service as an example. Select other APIs for use with other Autodesk Platform Services.

  6. In a terminal window, run the following command to obtain an access token:

    curl -v 'https://developer.api.autodesk.com/authentication/v1/authenticate'
    -X 'POST'
    -H 'Content-Type: application/x-www-form-urlencoded'
    -d '
        client_id=CLIENT_ID&
        client_secret=CLIENT_SECRET&
        grant_type=client_credentials&
        scope=data:read
    '

  7. Copy the value of the access_token attribute from the response json.

  8. Run the following command to register a webhook to Autodesk Data Management:

    curl -X 'POST'\
     -v 'https://developer.api.autodesk.com/webhooks/v1/systems/data/events/dm.*/hooks'\
     -H 'Content-Type: application/json'\
     -H 'authorization: Bearer ACCESS_TOKEN'\
     -d '{
            "callbackUrl": "CALLBACK_URL",
            "scope": {
                 "folder": "FOLDER_URN"
            },
            "hookAttribute": {
                 "projectId": "PROJECT_ID",
            },
            "filter": "$[?(@.ext=='txt')]"
      }'

    Note: Replace the following with the corresponding values:

    • ACCESS_TOKEN: the access token copied on previous steps.
    • CALLBACK_URL: the URL provided by the ngrok agent to expose your application to the internet (i.e. https://1a2b-3c4d-5e6f-7g8h-9i0j.sa.ngrok.io).
    • FOLDER_URN: Your Autodesk Data Management folder URN
    • PROJECT_ID: Your Autodesk Data Management project ID.

  9. Make sure the response from the above command is HTTP/1.1 201.

Run Webhooks with Autodesk and ngrok​

Autodesk Platform Services sends a different request to your webhook endpoint depending on the event being triggered. For example, you can trigger new calls from Autodesk to your application whenever you add a file to a folder in Data Management.

  1. On your desktop start menu, select Autodesk Data Management, click Autodesk Data Management Server Console and sign in using your username and password.

  2. Access the folder you assigned to your webhook, upload a text file, and confirm your localhost app receives a notification and logs both headers and body in the terminal.

Inspecting requests​

When you launch the ngrok agent on your local machine, you can see two links:

  • The URL to your app (it ends with ngrok-free.app for free accounts or ngrok.app for paid accounts when not using custom domains)
  • A local URL for the Web Interface (a.k.a Request Inspector).

The Request Inspector shows all the requests made through your ngrok tunnel to your localhost app. When you click on a request, you can see details of both the request and the response.

Seeing requests is an excellent way of validating the data sent to and received by your app via the ngrok tunnel. That alone can save you some time dissecting and logging HTTP request and response headers, methods, bodies, and response codes within your app just to confirm you are getting what you expect.

To inspect Autodesk's webhooks call, launch the ngrok web interface (i.e. http://127.0.0.1:4040), and then click one of the requests sent by Autodesk.

From the results, review the response body, header, and other details:

ngrok Request Inspector

Replaying requests​

The ngrok Request Inspector provides a replay function that you can use to test your code without the need to trigger new events from Autodesk. To replay a request:

  1. In the ngrok inspection interface (i.e. http://localhost:4040), select a request from Autodesk.

  2. Click Replay to execute the same request to your application or select Replay with modifications to modify the content of the original request before sending the request.

  3. If you choose to Replay with modifications, you can modify any content from the original request. For example, you can modify the id field inside the body of the request.

  4. Click Replay.

Verify that your local application receives the request and logs the corresponding information to the terminal.

Secure webhook requests​

The ngrok signature webhook verification feature allows ngrok to assert that requests from your Autodesk webhook are the only traffic allowed to make calls to your localhost app.

Note: This ngrok feature is limited to 500 validations per month on free ngrok accounts. For unlimited, upgrade to Pro or Enterprise.

This is a quick step to add extra protection to your application.

  1. Run the following command to register a webhook secret to your webhook:

    curl -X 'POST'\
     -v 'https://developer.api.autodesk.com/webhooks/v1/tokens'\
     -H 'Content-Type: application/json'\
     -H 'authorization: Bearer ACCESS_TOKEN'\
     -d '{
            "token": "YOUR_WEBHOOK_SECRET"
      }'

    Note: Replace the following with the corresponding values:

    • ACCESS_TOKEN: the access token copied on previous steps.
    • YOUR_WEBHOOK_SECRET: a value to sign each webhook request.

  2. Make sure the response from the above command is HTTP/1.1 200.

  3. Restart your ngrok agent by running the command, replacing {your client secret} with the value you copied before:

    ngrok http 3000 --verify-webhook autodesk --verify-webhook-secret {your client secret}

  4. Access the folder you assigned to your webhook, upload a text file, and confirm your localhost app receives a notification and logs both headers and body in the terminal.