/
Order Create Update Webhook Event

We’re excited to announce that the latest information is now available on our new site, the Ginesys One Wiki!. Visit the site for up-to-date resources and insights. We look forward to continuing to support you there!

Order Create Update Webhook Event

Browntape allows users to register webhooks. These are YOUR end points which will get called at the order create/update event. The POST HTTP request made to your end point will have the order payload with a json similar to the response of order fetch API (above).

 

To register the order webhook, please contact your account manager with the following details:

  • Your BT API user which you want use for authentication.

  • The URL or the end point where you wish to receive POST requests for new orders.

  • Any headers that you might want us to send along with the POST request (in 'Header-name: value' format).

 

Things to Remember while coding your end point:

  • The request BT makes at the order create event will be a POST request.

  • To authorize this request, BT will send the auth string which you usually send while making API requests to BT. The password and api_secret used here will be of the BT API user you specify while registering the webhook.

  • BT will call your endpoint with a connection and response timeout of 20 secs. If no response is received in, it will fail. At this point, no retry has been implemented.

  • Your end point should respond with HTTP status 200. If any other status is received, it will be deemed as a failure. 

  • The body of your response is ignored. But, keep it short (example: 'OK' or 'success') to keep the call fast on the network.

  • A log of all the webhook calls we make can be found in the 'Activities' section of BT.

  • In one call, no more than 50 orders will be sent. If there are more than 50 orders created in BT at once, they will be sent in multiple calls.

  • For update orders, the webhook will be triggered if the update we receive is from channel.

  • Any status updates on the order from the Browntape UI or API will also trigger the webhook.

Related content