Scheduled Order Webhooks
Webhooks are a great way for developers to receive Scheduled Order data when changes are made to Scheduled Orders. Our Zapier integration also creates webhooks in QPilot to handle workflows created in Zapier. See more details about working with webhooks in our QPilot developer documentation.
Action Types
| Webhook Action Type | PreviousScheduledOrder | NewScheduledOrder | Description |
| CreateScheduledOrder | null | The new scheduled order. | A new scheduled order was created. |
| UpdateScheduledOrder | The previous scheduled order. | The updated scheduled order. | The scheduled order was updated. |
| PauseScheduledOrder | The previous scheduled order. | The updated scheduled order. | The scheduled order was paused. |
| ActivateScheduledOrder | The previous scheduled order. | The updated scheduled order. | The scheduled order was activated. |
| CreateScheduledOrderItem | The previous scheduled order. | The updated scheduled order. | An item was added to the scheduled order. |
| UpdateScheduledOrderItem | The previous scheduled order. | The updated scheduled order. | An item was updated in the scheduled order. |
| DeleteScheduledOrderItem | The previous scheduled order. | The updated scheduled order. | An item was deleted from the scheduled order. |
| UpdateScheduledOrderItemQuantity | The previous scheduled order. | The updated scheduled order. | The quantity of an item was updated. |
| UpdateScheduledOrderItemPrice | The previous scheduled order. | The updated scheduled order. | The price of an item was updated. |
| UpdateScheduledOrderItemSalePrice | The previous scheduled order. | The updated scheduled order. | The sale price of an item was updated. |
| DeleteScheduledOrder | The previous scheduled order. | null | The scheduled order was deleted. |
| ScheduledOrderProcessed | The previous scheduled order. | The updated scheduled order. | The scheduled order was processed successfully |
| ScheduledOrderFailed | The previous scheduled order. | The updated scheduled order. | The scheduled order failed to process |
Example Payload
{
"Id": "59a7277537e9d410fc0f04f7",
"SiteId": 6,
"ActionType": "UpdateScheduledOrder, PauseScheduledOrder",
"AccessScope": "Merchant",
"PreviousScheduledOrder": {
"Id": 29,
"CustomerId": 126,
"Customer": {
"Id": 126,
"SiteId": 6,
"ExternalId": "236",
"Email": "billybob@email.com",
"FirstName": "Billy",
"LastName": "Bob",
"Created": "2017-08-29T22:14:37Z",
"ShippingFirstName": "Billy",
"ShippingLastName": "Bob",
"ShippingStreet1": "123 1st st",
"ShippingStreet2": null,
"ShippingCity": "Austin",
"ShippingState": "TX",
"ShippingPostcode": "78704",
"ShippingCountry": "US",
"BillingFirstName": "Billy",
"BillingLastName": "Bob",
"BillingStreet1": "123 1st st",
"BillingStreet2": null,
"BillingCity": "Austin",
"BillingState": "TX",
"BillingPostcode": "78704",
"BillingCountry": "US",
"CreatedUtc": "2017-08-29T22:14:43.443Z",
"UpdatedUtc": "2017-08-29T22:14:43.443Z"
},
"LastOccurrenceUtc": null,
"NextOccurrenceUtc": "2018-08-31T10:00:00Z",
"Status": "Active",
"CreatedUtc": "2017-08-29T22:14:44.27Z",
"UpdatedUtc": "2017-08-29T22:33:56.823Z",
"FrequencyType": "Weeks",
"Frequency": 3,
"Cycles": 0,
"PaymentMethodId": 8,
"PaymentMethod": {
"Id": 8,
"CustomerId": 126,
"Type": null,
"GatewayCustomerId": "cus_BIowVwz9q7gLMv",
"GatewayPaymentId": "card_1AwDIO4KYrVHKBRwkP6rqKFv",
"Description": "Visa ending in 4242 (expires 03/22)",
"BillingFirstName": null,
"BillingLastName": null,
"BillingStreet1": null,
"BillingStreet2": null,
"BillingCity": null,
"BillingState": null,
"BillingPostcode": null,
"BillingCountry": null,
"CreatedUtc": "2017-08-29T22:14:43.897Z",
"UpdatedUtc": "2017-08-29T22:14:43.897Z"
},
"CurrencyIso": "USD",
"Subtotal": 57.73,
"ShippingTotal": 30.5,
"TaxTotal": 3.608125,
"Total": 91.83813,
"ShippingFirstName": "Billy",
"ShippingLastName": "Bob",
"ShippingStreet1": "123 1st st",
"ShippingStreet2": null,
"ShippingCity": "Austin",
"ShippingState": "TX",
"ShippingPostcode": "78704",
"ShippingCountry": "US",
"ScheduledOrderItems": [
{
"Id": 53,
"ScheduledOrderId": 29,
"ProductId": 79,
"Product": {
"Id": 79,
"SiteId": 6,
"ParentProductId": null,
"ExternalId": "2795",
"Type": "simple",
"Sku": "",
"Title": "Belgian Ale Yeast 10g",
"Description": "<p>Belgian Ale Yeast is an exceptional top-fermenting yeast creating highly characterful beers with spicy, fruity and peppery notes ideal for Belgian Saison or farmhouse style beer.</p>\n",
"Price": 7.25,
"SalePrice": null,
"Length": "1",
"Width": "1",
"Height": "1",
"Weight": ".25",
"ShippingClass": null,
"TaxClass": null,
"ImageUrl": "https://testerjoeys.wpengine.com/wp-content/uploads/2015/05/yeast1.jpg",
"ImageThumbUrl": "https://testerjoeys.wpengine.com/wp-content/uploads/2015/05/yeast1.jpg",
"CreatedUtc": "2017-08-29T22:00:01.547Z",
"UpdatedUtc": "2017-08-30T22:00:21.323Z"
},
"Price": 7.25,
"SalePrice": null,
"Quantity": 3,
"CreatedUtc": "2017-08-29T22:14:44.303Z",
"UpdatedUtc": "2017-08-29T22:33:56.84Z"
},
{
"Id": 54,
"ScheduledOrderId": 29,
"ProductId": 50,
"Product": {
"Id": 50,
"SiteId": 6,
"ParentProductId": 48,
"ExternalId": "2719",
"Type": "variation",
"Sku": "",
"Title": "2-Row Malt (Milling Option: milled, Amount: 3 lbs)",
"Description": "<p>All-purpose base malt. Low in total nitrogen, well modified and high in enzymes. Light, clean, smooth flavor.</p>\n",
"Price": 4,
"SalePrice": null,
"Length": "1",
"Width": "1",
"Height": "1",
"Weight": ".25",
"ShippingClass": null,
"TaxClass": null,
"ImageUrl": "https://testerjoeys.wpengine.com/wp-content/uploads/2013/08/img_5491_2.jpg",
"ImageThumbUrl": "https://testerjoeys.wpengine.com/wp-content/uploads/2013/08/img_5491_2.jpg",
"CreatedUtc": "2017-08-29T21:59:49.847Z",
"UpdatedUtc": "2017-08-30T22:00:07.877Z"
},
"Price": 4,
"SalePrice": null,
"Quantity": 2,
"CreatedUtc": "2017-08-29T22:17:27.723Z",
"UpdatedUtc": "2017-08-29T22:33:56.84Z"
},
{
"Id": 56,
"ScheduledOrderId": 29,
"ProductId": 83,
"Product": {
"Id": 83,
"SiteId": 6,
"ParentProductId": null,
"ExternalId": "2846",
"Type": "simple",
"Sku": "",
"Title": "Das Beer Boot",
"Description": "<p>This ain’t no slipper Cindy. Das Beer Boot can hold enough brew for half the football team and still play the kicker. Shatter-proof, reinforced glass protects your belly’s future investments to boot.</p>\n<p>Glass. Clear. Boot-shaped.</p>\n",
"Price": 21.4,
"SalePrice": null,
"Length": "5",
"Width": "5",
"Height": "12",
"Weight": "5",
"ShippingClass": "hazardous",
"TaxClass": null,
"ImageUrl": "https://testerjoeys.wpengine.com/wp-content/uploads/2015/05/boot-01.jpg",
"ImageThumbUrl": "https://testerjoeys.wpengine.com/wp-content/uploads/2015/05/boot-01.jpg",
"CreatedUtc": "2017-08-29T22:00:01.67Z",
"UpdatedUtc": "2017-08-30T22:00:21.5Z"
},
"Price": 21.4,
"SalePrice": 13.99,
"Quantity": 2,
"CreatedUtc": "2017-08-29T22:32:36.663Z",
"UpdatedUtc": "2017-08-29T22:33:56.84Z"
}
]
},
"NewScheduledOrder": {
"Id": 29,
"CustomerId": 126,
"Customer": {
"Id": 126,
"SiteId": 6,
"ExternalId": "236",
"Email": "billybob@email.com",
"FirstName": "Billy",
"LastName": "Bob",
"Created": "2017-08-29T22:14:37Z",
"ShippingFirstName": "Billy",
"ShippingLastName": "Bob",
"ShippingStreet1": "123 1st st",
"ShippingStreet2": null,
"ShippingCity": "Austin",
"ShippingState": "TX",
"ShippingPostcode": "78704",
"ShippingCountry": "US",
"BillingFirstName": "Billy",
"BillingLastName": "Bob",
"BillingStreet1": "123 1st st",
"BillingStreet2": null,
"BillingCity": "Austin",
"BillingState": "TX",
"BillingPostcode": "78704",
"BillingCountry": "US",
"CreatedUtc": "2017-08-29T22:14:43.443Z",
"UpdatedUtc": "2017-08-29T22:14:43.443Z"
},
"LastOccurrenceUtc": null,
"NextOccurrenceUtc": "2018-08-31T10:00:00Z",
"Status": "Paused",
"CreatedUtc": "2017-08-29T22:14:44.27Z",
"UpdatedUtc": "2017-08-30T21:00:34.962Z",
"FrequencyType": "Weeks",
"Frequency": 3,
"Cycles": 0,
"PaymentMethodId": 8,
"PaymentMethod": {
"Id": 8,
"CustomerId": 126,
"Type": null,
"GatewayCustomerId": "cus_BIowVwz9q7gLMv",
"GatewayPaymentId": "card_1AwDIO4KYrVHKBRwkP6rqKFv",
"Description": "Visa ending in 4242 (expires 03/22)",
"BillingFirstName": null,
"BillingLastName": null,
"BillingStreet1": null,
"BillingStreet2": null,
"BillingCity": null,
"BillingState": null,
"BillingPostcode": null,
"BillingCountry": null,
"CreatedUtc": "2017-08-29T22:14:43.897Z",
"UpdatedUtc": "2017-08-29T22:14:43.897Z"
},
"CurrencyIso": "USD",
"Subtotal": 57.73,
"ShippingTotal": 30.5,
"TaxTotal": 3.608125,
"Total": 91.83813,
"ShippingFirstName": "Billy",
"ShippingLastName": "Bob",
"ShippingStreet1": "123 1st st",
"ShippingStreet2": null,
"ShippingCity": "Austin",
"ShippingState": "TX",
"ShippingPostcode": "78704",
"ShippingCountry": "US",
"ScheduledOrderItems": [
{
"Id": 53,
"ScheduledOrderId": 29,
"ProductId": 79,
"Product": {
"Id": 79,
"SiteId": 6,
"ParentProductId": null,
"ExternalId": "2795",
"Type": "simple",
"Sku": "",
"Title": "Belgian Ale Yeast 10g",
"Description": "<p>Belgian Ale Yeast is an exceptional top-fermenting yeast creating highly characterful beers with spicy, fruity and peppery notes ideal for Belgian Saison or farmhouse style beer.</p>\n",
"Price": 7.25,
"SalePrice": null,
"Length": "1",
"Width": "1",
"Height": "1",
"Weight": ".25",
"ShippingClass": null,
"TaxClass": null,
"ImageUrl": "https://testerjoeys.wpengine.com/wp-content/uploads/2015/05/yeast1.jpg",
"ImageThumbUrl": "https://testerjoeys.wpengine.com/wp-content/uploads/2015/05/yeast1.jpg",
"CreatedUtc": "2017-08-29T22:00:01.547Z",
"UpdatedUtc": "2017-08-30T22:00:21.323Z"
},
"Price": 7.25,
"SalePrice": null,
"Quantity": 3,
"CreatedUtc": "2017-08-29T22:14:44.303Z",
"UpdatedUtc": "2017-08-30T21:00:35.314Z"
},
{
"Id": 54,
"ScheduledOrderId": 29,
"ProductId": 50,
"Product": {
"Id": 50,
"SiteId": 6,
"ParentProductId": 48,
"ExternalId": "2719",
"Type": "variation",
"Sku": "",
"Title": "2-Row Malt (Milling Option: milled, Amount: 3 lbs)",
"Description": "<p>All-purpose base malt. Low in total nitrogen, well modified and high in enzymes. Light, clean, smooth flavor.</p>\n",
"Price": 4,
"SalePrice": null,
"Length": "1",
"Width": "1",
"Height": "1",
"Weight": ".25",
"ShippingClass": null,
"TaxClass": null,
"ImageUrl": "https://testerjoeys.wpengine.com/wp-content/uploads/2013/08/img_5491_2.jpg",
"ImageThumbUrl": "https://testerjoeys.wpengine.com/wp-content/uploads/2013/08/img_5491_2.jpg",
"CreatedUtc": "2017-08-29T21:59:49.847Z",
"UpdatedUtc": "2017-08-30T22:00:07.877Z"
},
"Price": 4,
"SalePrice": null,
"Quantity": 2,
"CreatedUtc": "2017-08-29T22:17:27.723Z",
"UpdatedUtc": "2017-08-30T21:00:35.315Z"
},
{
"Id": 56,
"ScheduledOrderId": 29,
"ProductId": 83,
"Product": {
"Id": 83,
"SiteId": 6,
"ParentProductId": null,
"ExternalId": "2846",
"Type": "simple",
"Sku": "",
"Title": "Das Beer Boot",
"Description": "<p>This ain’t no slipper Cindy. Das Beer Boot can hold enough brew for half the football team and still play the kicker. Shatter-proof, reinforced glass protects your belly’s future investments to boot.</p>\n<p>Glass. Clear. Boot-shaped.</p>\n",
"Price": 21.4,
"SalePrice": null,
"Length": "5",
"Width": "5",
"Height": "12",
"Weight": "5",
"ShippingClass": "hazardous",
"TaxClass": null,
"ImageUrl": "https://testerjoeys.wpengine.com/wp-content/uploads/2015/05/boot-01.jpg",
"ImageThumbUrl": "https://testerjoeys.wpengine.com/wp-content/uploads/2015/05/boot-01.jpg",
"CreatedUtc": "2017-08-29T22:00:01.67Z",
"UpdatedUtc": "2017-08-30T22:00:21.5Z"
},
"Price": 21.4,
"SalePrice": 13.99,
"Quantity": 2,
"CreatedUtc": "2017-08-29T22:32:36.663Z",
"UpdatedUtc": "2017-08-30T21:00:35.315Z"
}
]
},
"Description": "Scheduled Order #29 updated for Customer #126",
"CreatedUtc": "2017-08-30T21:00:36.455Z",
"UpdatedUtc": "2017-08-30T21:00:36.455Z"
}