This feature is available on the Plus Plan only
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, Basecamp will call your payload URL.
Order/Status-Updated Sample Payload
{
"order_number":"1506",
"name":"#test1506",
"created_at":"2020-09-30T20:03:36+00:00",
"updated_at":"2023-01-25T19:25:58+00:00",
"closed_at":null,
"id":2807742791714,
"currency":"USD",
"fulfillment_status":"partial",
"w3_order_status":"40367",
"w3_order_status_name":"status 1 public",
"w3_order_status_updated":"2/1/2023 7:50:11 PM",
"w3_public_notes":"<p><img src=\"https://s3.amazonaws.com/order-status-image-uploads/nine5-2/pic_logo1.png\" /></p>",
"w3_private_notes":null,
"w3_due_date":"1/23/2023 12:00:00 PM",
"financial_status":"pending",
"confirmed":"true",
"cancel_reason":null,
"note":"",
"tags":"updated by flow, w3:Purchase-Order, w3os:status 1, w3dd:2023-01-23",
"email":"mdobarganes@site.com",
"subtotal_price":53.00,
"total_discounts":0.00,
"total_line_items_price":53.00,
"total_price":53.00,
"total_tax":2.52,
"total_weight":454.0,
"order_status_url":"https://site.myshopify.com/7415951/orders/552990633ce91ec4d5c7b20cb3ddaa16/authenticate?key=0dbf256544d529ac27968ad92a3b6f18",
"gateway":"Cash on Delivery (COD)",
"phone":null,
"Customer":{
"email":"mdobarganes@site.com",
"first_name":"megan",
"last_name":"dobarganes",
"id":400759848994,
"phone":null,
"metafields":[],
"Context":null
},
"shipping_lines":[],
"line_items":[
{
"id":"6117448482850",
"variant_id":null,
"product_id":null,
"title":"Panel Camp Cap",
"variant_title":"Burnt Orange / s",
"quantity":1.0,
"name":"Panel Camp Cap - Burnt Orange / s",
"image":null,
"sku":"4255OR",
"price":48.00,
"grams":454.0,
"vendor":"United By Blue",
"total_discount":0.00,
"gift_card":"false",
"fulfillable_quantity":1,
"fulfillment_service":"manual",
"fulfillment_status":null,
"properties":[
{
"name":"Add Monogram?",
"value":"Yes",
"Context":null
},
{...},
{...},
],
"Context":null
},
{...},
{...}
],
"billing_address":null,
"shipping_address":{
"first_name":"Megan",
"address1":"123 Main street",
"phone":"",
"city":"Houston",
"zip":"77002",
"province":"Texas",
"country":"United States",
"last_name":"Dobarganes",
"address2":"",
"company":null,
"latitude":null,
"longitude":null,
"name":"Megan Dobarganes",
"country_code":"US",
"province_code":"TX",
"Context":null
},
"discount_codes":[],
"fulfillments":[
{
"created_at":"2020-09-30T20:04:03+00:00",
"id":2666456907810,
"order_id":2807742791714,
"status":"success",
"tracking_company":null,
"tracking_number":null,
"tracking_url":null,
"updated_at":"2020-09-30T20:04:03+00:00",
"Context":null
}
],
"note_attributes":[
{
"name":"w3-cause",
"value":"13855",
"Context":null
}
],
"refunds":[],
"history":null,
"metafields":[]
}
Create new Webhook
Steps:
- Go to Integrations page
- Scroll down to Webhooks section
- Select desired Event
- Enter URL to send payload
- Press Add
Delete Webhook
Steps:
- Go to Integrations page
- Scroll down to Webhooks section
- Select trashcan icon next to webhook
- Press Yes in confirmation dialog