Webhook Types

There are two types of webhook to expect, Status and Event.

Status

The status webhook lets you know if your order as been completely accepted or rejected. It is possible for an order to be rejected if there is an issue accessing the image assets included in the order request JSON.

Accepted Example
1
2
3
4
5
6
7
8
9
10
{
	"Status": "Accepted",
	"Errors": [],
	"OrderNumber": 14989342,
	"Event": "Processed",
	"ConfirmationId": "a3ff9b4a-3112-4101-88ab-6ba025fd7600",
	"EntryId": "12345",
	"Reference": "OrderID 12345",
	"SequenceNumber": "1"
}
Rejected Example
1
2
3
4
5
6
7
8
9
10
11
12
13
{
	"Status": "Rejected",
	"Errors": [{
		"ErrorCode": "400.03",
		"Error": "Error copying files from consumer.",
		"AssetPath": "https://whcc-api-testing.s3.amazonaws.com/sample-images/not-valid-image-1.jpg"
	}],
	"Event": "Processed",
	"ConfirmationId": "a3ff9b4a-3112-4101-88ab-6ba025fd7600",
	"EntryId": "12345",
	"Reference": "OrderID 12345",
	"SequenceNumber": "1"
}

Event

The event webhook lets you know about a change in-production status of your order. Currently, the only event to be passed is Shipped. This will change in the future, so please look for a specific event value when processing this webhook type.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
	"ShippingInfo": [{
		"Carrier": "FedEx",
		"ShipDate": "2018-12-31T06:18:38-06:00",
		"TrackingNumber": "512376671311227",
		"TrackingUrl": "http://www.fedex.com/Tracking?tracknumbers=512376671311227",
		"Weight": 0.35
	}],
	"OrderNumber": 14989342,
	"Event": "Shipped",
	"ConfirmationId": "a3ff9b4a-3112-4101-88ab-6ba025fd7600",
	"EntryId": "12345",
	"Reference": "OrderID 12345",
	"SequenceNumber": "1"
}

What's Next

Security and Signatures describes the process to validate the callback requests

Back to Top 👆
Get in Touch

Interested in integrating with WHCC? Tell us more about what you’re looking for and we’ll be in touch.