Skip to main content
WEBHOOK

Webhook overview

Webhooks work differently to the API endpoints. Take a read of our guide to understand how they work.
This event is essential when using the async ordering mode if you need to take action when an order has completed processing. It’s also useful if you want to feed ordering data into your system. The webhook payload depends on whether the order was processed successfully or not. You should use the status field to determine the type of payload you have received.
  • Successfully completed orders will have a status of COMPLETED
  • Failed orders will have a status of FAILED

Body

application/json

Sent when an order finishes processing, the body object will be one of the following schemas depending on the order status.

Webhook message sent when an order has completed processing.

​
id
string
required

The ID of the order.

Example:

"O-01H5WQGHKCBB85MQFM68S9KJ5Q"

​
status
enum<string>
required

Always COMPLETED for this schema.

Available options:
COMPLETED
Example:

"PROCESSING"

​
created_at
string<date-time>
required

UTC timestamp, in ISO 8601 format, when the order was submitted.

​
payment_method
Payment Method · object
required

The payment method used for the order.

​
currency
string<iso-4217>
required

The currency of the order, represented by ISO 4217 currency codes. Please check the currency section in the guidelines for how to use this field.

Pattern: ^[A-Z]{3}$
Example:

"USD"

​
total_price
string<decimal>
required

The total price of the order. This includes any applicable fees.

Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"10.00"

​
total_discount
string<decimal>
required

The total discount of the order.

Pattern: ^[0-9]+(\.[0-9]{1,2})?$
Example:

"1.00"

​
completed_at
string<date-time>

UTC timestamp, in ISO 8601 format, when the order was completed.

​
description
string | null

Free format text reference for the order. The order description will not be visible to the end user. You will see this description in the Runa web portal.

This field is optional and can be omitted if not needed. If not provided, the field will be set to null in the response.

Maximum string length: 128
Example:

"Your own reference text"

Response

200

Return a 200 status to indicate that the data was received successfully