Skip to main content

AfterShip Webhooks

TL;DR

To integrate AfterShip webhooks with ngrok:

  1. Launch your local webhook. npm start
  2. Launch ngrok. ngrok http 3000
  3. Configure AfterShip 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 AfterShip by using Webhooks. AfterShip webhooks can be used to notify an external application whenever specific events occur in your AfterShip account.

By integrating ngrok with AfterShip, you can:

  • Develop and test AfterShip 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 AfterShip in real-time via the inspection UI and API.
  • Modify and Replay AfterShip Webhook requests with a single click and without spending time reproducing events manually in your AfterShip account.
  • Secure your app with AfterShip 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:

Loading…

This will get the project installed locally.

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

Loading…

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:

    Loading…

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

Step 3: Integrate AfterShip​

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

  1. Access AfterShip and sign in using your AfterShip account.

  2. On the left menu, click Notifications and then click Webhooks.

  3. On the Webhooks page, click Add webhook URL.

  4. On the Add webhook URL popup, enter the URL provided by the ngrok agent to expose your application to the internet in the Webhook URL field (i.e. https://1a2b-3c4d-5e6f-7g8h-9i0j.ngrok.app). aftership URL to Publish

  5. Click Save.

    Confirm your localhost app receives a notification and logs both headers and body in the terminal.

Run Webhooks with AfterShip and ngrok​

AfterShip sends different request body contents depending on the status of the shipments created in your account. You can trigger new calls from AfterShip to your application by following the instructions below.

  1. On the AfterShip console, click Shipments on the left menu and then click Add shipment.

  2. On the Add new shipment page, enter a tracking number in the Tracking no. field and then click Save shipment. Optionally, you can fill in all fields on this page.

    Confirm your localhost app receives an event 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 retrieved 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 AfterShip'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 AfterShip.

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 AfterShip. To replay a request:

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

  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 tracking_number 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 AfterShip 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. Access AfterShip and sign in using your AfterShip account.

  2. On the left menu, click Notifications and then click Webhooks.

  3. On the Webhooks page, copy the value of the Webhook secret.

  4. Restart your ngrok agent by running the command, replacing {your webhook secret} with the value you have copied before (See Integrate ngrok and AfterShip.):

    Loading…

  5. Access AfterShip and create a new shipment.

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