Webhooks

A collection of webhook requests that Musement's API can make to a partner's service.

Update order itemWebhook POST

The API sends this request to a partner's service when an order item status changes (for example from PENDING to OK).

The body of the response is ignored. A 200 status code response confirms the request has been received and will be processed. All other status codes are treated as a failed attempt - another webhook request will be sent later.

For more info, check out our guide.
SecurityWebhook
Request
header Parameters
Content-Type
required
string

The format of the request and response.

Value: application/json
Request Body schema: application/json
order_created
required
string <date-time>

When the order was created.

order_id
required
string <^[0-9]+?$>

The order's numeric ID.

order_item_created
required
string <date-time>

When the order item was created.

order_item_status
required
string

The status of the order item:

  • CANCELLATION_ERROR: an error occurred while processing a cancellation. This status is temporary and will change to either OK or REFUNDED after examination by Musement Customer Care
  • KO: there was an issue finalizing the order item
  • OK: the order item is valid
  • PENDING: the order item's payment and confirmation are in progress
  • REFUND_STARTED: a refund request for the item is being processed. This status is temporary and will change to REFUNDED once the request has been resolved
  • REFUNDED: the order item has been cancelled and either partially or fully refunded
Enum: CANCELLATION_ERROR KO OK PENDING REFUNDED REFUND_STARTED
order_item_updated
required
string <date-time>

When the order item was last updated.

order_item_uuid
required
string <uuid>

The order item's UUID

order_item_version
required
string <^[0-9]+?$>

A counter which tracks how many times the order item has been updated.

order_updated
required
string <date-time>

When the order was last updated.

order_uuid
required
string <uuid>

The order's UUID,

order_version
required
string <^[0-9]+?$>

A counter which tracks how many times the order has been updated.

Responses
200

Order item request successfully received

Request samples
application/json
{
  • "order_id": "13459345",
  • "order_uuid": "8e9e5c6e-ea7d-4934-8753-f00954f30d00",
  • "order_created": "2018-12-10T13:12:40+0000",
  • "order_updated": "2018-12-10T13:12:40+0000",
  • "order_version": "16",
  • "order_item_created": "2018-12-10T13:12:40+0000",
  • "order_item_status": "OK",
  • "order_item_updated": "2018-12-10T13:12:40+0000",
  • "order_item_uuid": "11045e18-e3ca-42e1-acb4-0d5be75036fd",
  • "order_item_version": "22"
}