order

Webhook notification triggered when order is created or updated

WEBHOOK order

Example

{
  "id": "<string>",
  "type": "order.created",
  "object": "event",
  "created": "2023-11-07T05:31:56Z",
  "data": {
    "orderId": "<string>",
    "merchantReferenceId": "<string>",
    "invoiceId": "<string>",
    "customerId": "<string>",
    "createTime": 1754819711382,
    "productId": "<string>",
    "priceId": "<string>",
    "priceDataList": [
      {
        "name": "<string>",
        "unitAmount": 1,
        "quantity": 2,
        "currency": "<string>",
        "imageUrl": "<string>"
      }
    ],
    "paymentMethod": {
      "paymentMethodType": "CARD",
      "paymentInstrumentId": "<string>"
    },
    "amountSubtotal": 9.99,
    "amountTotal": 9.99,
    "paymentCurrency": "USD",
    "originalCurrency": "USD",
    "status": "success",
    "sessionId": "<string>",
    "metadata": {}
  }
}

Authorizations

X-API-KEY · string · header · required

Your secret API key obtained from the Clink dashboard (Developers section)

X-Timestamp · string · header · required

Current timestamp in milliseconds since Unix epoch (required for request signing)

Body

application/json

Order event payload in json

id · string

Unique identifier for the event

type · enum<string>

Type of event that occurred

Available options: order.created, order.next_action, order.succeeded, order.failed

object · string

Type of this json payload, 'event' if this is an event

Example:

"event"

created · string<date-time>

Timestamp when the event occurred

data · object

Show child attributes

Response

200

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