Working with Webhooks

Order Status Growth Plan Required

Order Status can notify your application when something is changed through webhooks. A webhook consists of a payload URL to be called, which must be HTTPS, and a list of types that will trigger calls.



We will attempt to call the payload URL up to 5 times before deactivating the webhook. We will only consider a HTTP status code in the 2xx range to be a successful response. We will not follow a 3xx redirect.



A webhook can be subscribed to updates from the types detailed below.

  • Order :: Status Updated


Whenever an event is created for any of the types that webhook was created to match, Order Status will call your payload URL.



Order/Status-Updated Sample Payload


Create new Webhook

Steps:


  1. Go to Integrations page
  2. Scroll down to Webhooks section
  3. Select desired Event
  4. Enter URL to send payload
  5. Press Add

Delete Webhook

Steps:


  1. Go to Integrations page
  2. Scroll down to Webhooks section
  3. Select trashcan icon next to webhook
  4. Press Yes in confirmation dialog


Was this article helpful?

0 out of 0 liked this article

Still need help? Message Us