Skip to main content
WEBHOOK

Headers

Signature
string
required

HMAC SHA256 signature of the request body. Generated using the webhook's signing key and the raw JSON payload.

Generate the same value in your endpoint and compare it with this header to validate the webhook payload.

Example:

"a1b2c3d4e5f67890abcdef1234567890abcdef1234567890abcdef1234567890"

Body

application/json

Payload delivered for order and payment-related events. Combines the order resource with the common webhook envelope fields (event, timestamp, trigger, source).

Order recording a purchase made on the account, including billing details, line items, applied discounts, tax and fees, totals, and payment and transaction status.

address
string

Billing street address supplied for the order.

city
string

Billing city supplied for the order.

comments
string

Free-text comments recorded against the order.

company
string

Billing company name supplied for the order.

country
string

Billing country supplied for the order.

created_at
string<date-time>

Date and time the order was created, in ISO 8601 format.

currency
string

Currency the order amounts are denominated in, as an ISO 4217 code.

discount
number

Total discount applied to the order, in the order currency.

discount_code
string

Discount code applied to the order.

Empty string when no code was applied.

e_invoice_status
string

Electronic invoicing status of the order.

invoice_number
string

Invoice number assigned to the order.

ip_address
string<ip-address>

IP address the order was placed from.

items
string

HTML-formatted summary of the line items for the order, suitable for display.

items_array
object[]

Structured list of the line items for the order.

member_number
string

Membership number recorded against the order.

payment_method
string

Method used to pay for the order.

payment_status
string

Payment status of the order.

postcode
string

Billing postcode supplied for the order.

processing_fee
number

Processing fee charged on the order, in the order currency.

processing_fee_rate
number | null

Rate used to calculate the processing fee, as a percentage.

null when no processing fee applies.

region
string

Billing region supplied for the order.

season
object

Season the order was placed in.

slug
string

Short URL-safe identifier for the order.

state
string

Billing state supplied for the order.

subtotal
number

Order subtotal before tax and fees, in the order currency.

tax
number

Total tax charged on the order, in the order currency.

tax_rate
number | null

Rate used to calculate tax, as a percentage.

null when no tax applies.

tax_rate_details
object

Details of the tax rate applied to the order.

tax_term
string

Display term used for tax on the order, such as VAT or GST.

total
number

Order total including tax and fees, in the order currency.

transaction_date
string<date-time> | null

Date and time of the payment transaction, in ISO 8601 format.

null when the order has no recorded payment transaction.

transaction_provider
string

Payment provider that processed the transaction.

transaction_reference
string

Reference assigned to the transaction by the payment provider.

transaction_status
string

Status of the payment transaction.

user
object

User who placed the order.

vat_number
string

VAT number supplied for the order.

event
string

Human-readable name of the event that triggered the webhook.

Example:

"Order payment success"

timestamp
string<date-time>

ISO 8601 formatted datetime indicating when the event occurred.

Example:

"2020-01-01T00:00:00Z"

trigger
string

Machine-readable event key that fired the webhook. Full list of events can be found here.

Example:

"order_payment_success"

source
enum<string>
default:ui

Origin of the change that triggered the event.

Available options:
ui,
api

Response

200

Return any 2xx status code to acknowledge receipt of the event.