Checkout Update

webhook

https://yourwebhook.com/checkout_update

Purpose

Delivers a checkout update event dependant on successful processing into the integrated POS

Format

The webhook event will confirm orders as either completed (successfully created in POS) or failed (an unexpected error has occured)

Payload

locationId

string

Unique customer locationId of the store the checkout was placed at.

channelLinkId

string

The channelLinkId is the unique identifier of the store the checkout was placed at.

checkoutId

string

Unique identifier of the checkout session, can also be retrieved via Get Checkout.

status

string

enum

Final checkout processing status.

Allowed:

reason

string | null

Where available, the reason a checkout failed, will be null when the checkout is completed successfully

updatedAt

date-time

Timestamp when the checkout status was last updated, in the format yyyy-MM-ddTHH:mm:ss.SSSSSS+HH:mm.

Headers

User-Agent

string

required

Defaults to Deliverect/{version}

Identifies Deliverect as the sender of the webhook, in the format Deliverect/{version}.

X-Server-Authorization-HMAC-SHA256

string

required

Defaults to {signature}

HMAC-SHA256 signature of the raw request body, generated with your shared secret. Recompute the signature on receipt and compare it to this value to verify the request came from Deliverect (see the HMAC authentication guide).

Response

Purpose

Format

200200