Skip to main content
WEBHOOK
session
{
  "id": "<string>",
  "object": "event",
  "created": "<string>",
  "type": "session.complete",
  "data": {
    "sessionId": "<string>",
    "token": "<string>",
    "status": "<string>",
    "paymentStatus": "<string>",
    "amountSubtotal": 0,
    "amountTotal": 0,
    "originalCurrency": "<string>",
    "paymentCurrency": "<string>",
    "subscriptionId": "<string>",
    "invoiceId": "<string>",
    "orderId": "<string>",
    "price": {
      "priceId": "<string>",
      "priceList": [
        {
          "amount": 0,
          "currency": "<string>",
          "exchangeRate": 0
        }
      ],
      "recurring": {
        "freeTrialDays": 0,
        "interval": "<string>"
      }
    },
    "merchantReferenceId": "<string>",
    "customer": {
      "customerId": "<string>",
      "email": "<string>"
    },
    "locale": "<string>",
    "cancelUrl": "<string>",
    "successUrl": "<string>",
    "created": "<string>",
    "expire": "<string>",
    "product": {
      "productId": "<string>",
      "productName": "<string>"
    },
    "priceDataList": [
      {
        "name": "<string>",
        "quantity": 0,
        "unitAmount": 0,
        "currency": "<string>",
        "imageUrl": "<string>"
      }
    ]
  }
}

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

Session event payload in json

​
id
string

Unique identifier for the event

​
type
enum<string>

Type of event that occurred

Available options:
session.complete,
session.expired
Example:

"session.complete"

​
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

Response

200

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