DSV Webhooks

Created by Brian Glick, Modified on Tue, 4 Nov at 11:53 AM by Brian Glick

DSV Webhooks API offers a efficient solution for real-time notifications and data updates from DSV services. By integrating this API into your systems, you can receive event-based notifications directly from DSV, keeping you informed about shipment updates, order changes, tracking information, and more.

 

Authentication and Access: To ensure secure access to DSV Webhooks API, it is essential to authenticate your requests using appropriate methods such as API keys or OAuth. Before getting started, make sure you have the necessary access permissions to register webhooks and receive webhook events.

Steps for Access:

  1. Create a DSV developer account on the DSV website. DSV Webhooks API Configuration Guide
  2. Enable webhooks for your account. Contact DSV via email and request the activation of webhooks for your developer account. They will guide you through the process.
  3. Use the URL generated by your Receive HTTPs listener. This URL serves as the endpoint for receiving webhook notifications.

Configuring Your Webhook

You can add a webhook to any flow at the bottom of the flow configuration screen.  

  1. Under the Notifications tab, Click the green + button to add a new webhook.
  2. Enter the address where you would like the webhook to be delivered.
  3. Optionally: Enter an API Key that you would like the webhook to include as an "x-api-key" header on every request to your server
  4. Check the Success, Skip, Fail checkboxes to receive webhooks for successful flows, failed flows, skipped flows, or all.
  5. Don't forget to save the flow before leaving the screen.

 

webhooks.png

Subscribe to Webhooks

You can subscribe to webhooks for successful flows, failed flows or both.  You can use this feature to do the following: 

  1. Showing the status of integrations to users within your application
  2. Opening internal help desk tickets for failures
  3. Retrieving attribute data from data tags generated by your trading partner's adapter

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article