Webhook Register

Webhooks allow you to receive status updates on orders you have submitted as they move through the order lifecycle.

Processing webhooks is very important, as otherwise you will not be notified of any issues that may prevent your orders from being processed.

Requirements

You need to register and verify the endpoint you'd like to receive webhooks. The Order Submit API will POST to this endpoint as events occur, retrying if needed if your endpoint does not return a valid response.

POST /api/callback/create

Content-type: application/json

Each set of API credentials can only have a single webhook address enabled at one time.

Example Request
1
2
3
4
curl https://apps.whcc.com/api/callback/create  \
	-H "Authorization: Bearer 726670514499" \
	-F callbackUri=https://path.to.your/webhook/endpoint \
	-X POST
Copy to Clipboard

We will immediately POST to callbackUri with a parameter verifier with a unique verification code. Use the endpoint below to submit this verification code to prove you control the endpoint and enable webhooks to be sent to that address.

POST /api/callback/verify

Content-type: application/json

Example Request
1
2
3
4
curl https://apps.whcc.com/api/callback/verify  \
	-H "Authorization: Bearer 726670514499" \
	-F verifier=a53ae191-00f3-44f4-810c-19d88a5b4c16 \
	-X POST
Copy to Clipboard

Your webhook endpoint is now setup and ready to go.

Webhook Types describes the different types of messages to expect.

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.