API Documentation

Webhooks

A webhook can be created for a dawanda user (shop) and for every trigger individually or some/all. A POST request will be triggered to the given URL (can be different for each trigger) when a selected event is triggered. The request will contain the corresponding payload XML.

Failures / Retrying

If a webhook request fails, we will retry 6 times. First, after 15 seconds, then after 1 minute, then 30 minutes and then three times after 2 hours. If all 7 requests fail, we will stop retrying.

Available Triggers

Order Created

This webhook is triggered for every newly placed order.

Payload example:

<?xml version="1.0" encoding="UTF-8"?>
<dawanda>
  <trigger>order_created</trigger>
  <order_id>23456</order_id>
  <shop_id>12345</shop_id>
</dawanda>

Order Comment

This webhook is triggered every time a new comment is added to the order.

Payload example:

<?xml version="1.0" encoding="UTF-8"?>
<dawanda>
  <trigger>order_comment</trigger>
  <order_id>12345</order_id>
  <commenter>john</commenter>
  <text>Hello</text>
  <shop_id>2345</shop_id>
</dawanda>

Payment Method Changed

This webhook is triggered every time the payment method of an order is changed.

Payload example:

<?xml version="1.0" encoding="UTF-8"?>
<dawanda>
  <trigger>order_payment_method_changed</trigger>
  <order_id>851963711</order_id>
  <shop_id>12345</shop_id>
  <payment_method>
    <id>11</id>
    <title>PayPal</title>
  </payment_method>
  <previous_payment_method>
    <id>9</id>
    <title>Cash</title>
  </previous_payment_method>
</dawanda>

Order Status Changed

This webhook is triggered every time the status of an order changes.

Payload Example:

<?xml version="1.0" encoding="UTF-8"?>
<dawanda>
  <trigger>order_status_changed</trigger>
  <order_id>851963711</order_id>
  <status>marked_as_paid</status>
  <shop_id>12345</shop_id>
</dawanda>

Order Seller Note Changed

This webhook is triggered when the seller sets or changes the order note (private comment)

Payload Example:

<?xml version="1.0" encoding="UTF-8"?>
<dawanda>
  <trigger>order_seller_note_changed</trigger>
  <order_id>851963711</order_id>
  <shop_id>12345</shop_id>
  <seller_note>Great buyer, include chocolate</seller_note>
</dawanda>

Webhook Management

Consult the following pages to find out how to manage webhooks for your shop: