The EasyPost Tracking API makes it simple to get EasyPost tracking updates with webhooks. Your application can be notified and take action as a tracking update happens. In this tutorial, we'll create a Flask application with the EasyPost Python Client that can receive webhooks from EasyPost. Then, we'll use the Twilio API to send a message to a test customer after a package gets delivered.
Although we'll use Flask (and Python) in this example application, this functionality could be integrated into any app written with Ruby, PHP, Java, and other languages with EasyPost's official client libraries.
The first thing we need is an API key from EasyPost. This is an example application, so we're going to use the test API key (of course, in a production application, you should use your production key.) You can find your test key on the API keys page.
In order to send SMS messages from our application, we'll use the Twilio API. Go to Twilio.com, click "Sign Up" and create an account. Once you're in, click the "Programmable SMS" button under "Products" to get your authentication details. You should see a page that looks something like this:
Copy the "Account SID" and "Auth Token". Then, click "Get your first Twilio Number" to generate the number the SMS messages will be sent from.
Next, open your favorite code editor and create a new file called
config.py. Fill in the test EasyPost API key and Twilio details, so it looks something like this:
Paste your "first Twilio number" in
SMS_TO_NUMBER, fill in the number of the cell phone you'd like to test with (of course, it must be able to receive SMS messages).
We'll need the Flask microframework, the EasyPost Python client, and the Twilio Python API to make our app. We can install all three with pip from the shell:
$ pip install flask easypost twilio
Next, we can start writing our app. Create a file called
app.py and save it in the same directory as
config.py. Here are the first few lines:
In these first couple of lines, we import the dependencies we installed, the app is defined and the config variables are loaded. In the last two lines, we instantiate the EasyPost and Twilio Python clients with the keys and tokens from
Now comes the meat of the application:
There are a few lines there, but the code is fairly straightforward! We know from the Webhooks Guide that incoming webhooks are POST requests, so we route
/easypost-webhook with the POST method. We also know from the Tracking API that webhooks for tracked packages come in an Event object, so we create one with the EasyPost Python client.
Next, we compose a message to be sent to the customer. In this example, we have some logic dependent on the status of the shipment, and create a message which includes the most recent tracking information. Because the order of tracking details can vary, we iterate through the list of tracking details until we find one that matches the status of the Tracker.
Lastly, we send an SMS message from our Twilio number with the message that we just generated. We only need more two lines, to run the app in debug mode on port 12345:
It's time to get the app started and see if we can get an SMS notification!
Open your shell, and run
$ python app.py. The app is now running on port 12345, but there's one problem - since it's running locally, EasyPost has no way to access it! In a production application, our app would be running on a remote server, but there's no need to set one up for this example. Instead, we use a tool called ngrok that can temporarily tunnel our app to the outside world.
Visit the ngrok website to install ngrok on your computer, then open a new shell. Simply run
$ ngrok http 12345, and ngrok will take care of all of the heavy lifting. You should see a URL that looks something like "https://something.ngrok.io" in ngrok's output - copy it.
All that's left is to tell EasyPost where to send our webhooks. You can do this from the webhooks page, or by running the following cURL command (replace xxxxxxxx.ngrok.io with your ngrok URL and insert your actual EasyPost test API key):
$ curl -X POST easypost.com/api/v2/webhooks -d 'webhook[url]=http://xxxxxxxx.ngrok.io/easypost-webhook&webhook[mode]=test' -u 'your-test-api-key:'
It's time to see the results of our hard work! EasyPost will send us a webhook after we create a test Tracker. We use a test tracking code, "EZ2000000002" (you can find the full list of test tracking codes here):
$ curl -X POST https://easypost.com/v2/trackers -d 'tracker[tracking_code]=EZ2000000002' -u 'your-test-api-key:'
In a few minutes, you should get a customized SMS message when an "update" occurs on the test Tracker:
Awesome! If you're interested, try playing with message customization using attributes listed in the Tracking API.
While this app isn't ready for production quite yet, it's a great example of what you can do with the EasyPost Tracking API. Here are some ideas for how you could extend this application:
You can download the code (with tests) for this tutorial on GitHub.