Skip to main content

3 posts tagged with "dev-tools"

View All Tags

· 4 min read
Alex Mullans

Whether you're using our white-label delivery product and need food to be picked up just as it's hot and ready to go, or you're bringing orders from DoorDash Marketplace into your point-of-sale and kitchen systems in the height of the dinner rush, you customers expect that everything "just works". To meet those expectations, we strive to ensure that every integration between DoorDash and our partnersmerchants, online ordering systems, point-of-sale systems, etc.is highly reliable.

To help integration providers create highly reliable integrations, we're introducing new tools that make it easier to monitor and troubleshoot an integration: integration health dashboards and event logs. We're also introducing tools and guides that enable every partner to build a more fully-featured integration right from the start, including an upgraded delivery simulator for DoorDash Drive and feature usage tracking built into the Developer Portal.

Monitor the health of your integration with new dashboards

We've introduced new dashboards in the Developer Portal that show you up-to-the-minute status, and a historical view, of API requests (from you to DoorDash) and webhooks (from DoorDash to you). You can use these dashboards to see, in ~real-time, if something is wrong between DoorDash and your systems. Soon, we'll also proactively notify you if we detect an issue with the integration, so that it's even faster to remediate and get back to accepting orders and requesting deliveries.

You can check out your dashboard in the Developer Portal - look for the new Overview tab!

A screenshot of the Developer Portal dashboard

Investigate issues using the event log

The Developer Portal now keeps a log of every API request & response we exchange with your integration, in addition to the webhook logs we introduced late last year. This can help if you're trying to troubleshoot issues with a particular delivery or order, because you can see the full request that DoorDash received from your integration and what we sent back as a result.

To get started with Event Logs, head into the Developer Portal and look for the Event Log tab.

A screenshot of the Developer Portal event log

tip

Personally identifiable information (or "PII") is redacted before it's stored in the Event Log. It's normal to see REDACTED in the Event Log when looking at a field that has PII, like dropoff_contact_given_name.

Track and discover new features

The new Features page in the Developer Portal will have a full list of all Marketplace and Drive features. Each feature will be linked to DoorDash’s developer documentation with detailed guides to help you implement and enable these features. As new features are built,they will be checked off helping you keep track of your integration.

A screenshot of the Developer Portal features

Get Started with Doordash APIs

The Getting Started Page will help guide you through the steps to successfully integrate with Doordash APIs. The page has step by step directions to help you to set up your test environment, generate access keys, and configure test stores. It also walks you through building required features for a Doordash integration and the steps to get your production environment approved.

A screenshot of the Developer Portal Get Started Page

Drive integrations: test "enroute" webhooks and more with an upgraded simulator

When you build an integration for Drive, our API for on-demand local delivery, you can use the Delivery Simulator to fully test out your integration and make sure you're prepared for anything that can happen during a live delivery. Based on feedback from our integration partners, we've added some frequently-requested capabilities to the simulator. You can now simulate:

To get started, go to the simulator, create a delivery, and look out for new options like the ones shown here:

A screenshot of the delivery simulator showing actions like sending an enroute webhook

Share your thoughts

Whether you're building an integration with DoorDash for the first time or you've been a partner for a long time, we look forward to your feedback on these new tools. Join us in the DoorDash Developer Discord and tell us your thoughts!

· 2 min read
Josh Hurley

After creating a new DoorDash Developer account, your next step is to explore the DoorDash Drive API. In order to communicate securely with DoorDash, your application must pass a JSON Web Token (JWT) to authenticate with our API. You’ll first want to create sandbox DoorDash Drive API credentials that will be used in generating a JWT. Many languages and frameworks provide libraries to create JWT for you. You can find examples for popular language in the step-by-step guide for creating a DoorDash JWT.

As you develop against the DoorDash Drive API, you can use the make-doordash-jwt CLI to generate a DoorDash JWT on Windows and Mac. When using Postman you use the DoorDash Postman Collection to create and send the JWT for each call.

You can learn more about the DoorDash JWT Format if your stack doesn’t support JWT creation, or if you’re looking to validate the output of your solution. Additionally, tools are available to you that illustrate the three parts of the DoorDash JWT in the JSFiddle JWT Sample and WinForms Sample App (for Windows users). A popular utility developers use to validate a JWT is the Auth0 JWT Debugger (check off the “secret base64 encoded” option when using the credentials provided by DoorDash. Please keep in mind that providing secrets on public websites carries a risk, and you should never expose your production credential secrets.

The DoorDash SDK Sample Application provides a prototype full stack solution with React and Node Express server that uses the Doordash SDK to communicate with the DoorDash Drive API. For developers that use WooCommerce, the JWT creation is provided in the plugin, the Get Started (WooCommerce Plugin) provides details on adding your credentials and configuring the plugin.

Please join our Discord community to share feedback and questions about the DoorDash JWT and getting started with DoorDash Drive!

· 2 min read
Brian Quach

Webhooks are a critical part of a successful on-demand delivery integration. They enable DoorDash to inform your integration about delivery updates, like when the Dasher has arrived at the pickup location or where they are along their route in real time. This real-time information lets you keep both the sender and receiver of the delivery up-to-date with precisely what’s happening.

It can be challenging to develop and test the part of your integration that receives and handles webhooks. How can you confirm that DoorDash sent a webhook that you were expecting to receive? How can you confirm that your application parsed the webhook details correctly?

We’re introducing Event Logs to answer exactly those kinds of questions. Event Logs is a new view in the Developer Portal that shows a history of all the webhooks sent to your integration. Each log includes the endpoint to which the webhook was sent, the HTTP response code DoorDash received from that endpoint, and the full body of the webhook that DoorDash sent. You can search for all the webhooks for a particular delivery ID or inspect all of the webhooks that were sent in a specific date range.

A screenshot of the Event Logs view in the Developer Portal

Enroute webhooks & other Drive API updates

Alongside the new Event Logs, we’ve also brought some new features to the Drive API:

  • enroute webhooks can now be enabled for your integration, so you can receive frequent updates on the Dasher’s location
  • The new dasher_allowed_vehicles field enables you to specify the transportation methods that a driverDasher can use to make the delivery: "car", "bicycle" and/or "walking"
  • You can use the items field to provide more detail about what’s in the delivery; this detail can be seen by Dashers as they’re making the deliveries and by the receiver of the delivery on the tracking page

Event Logs and all of these new features are ready to use today! Check out the Event Logs view in the Developer Portal, and see the Drive API docs for more details on the new Drive API features.