Webhook Schema

Apara delivers webhook events as JSON objects operating at user and order levels.

Top-Level Payload Fields

Field	Type	Description
`eventId`	string	Unique identifier for this event
`entityType`	string	`"user"` or `"order"`
`entityId`	string	Unique ID matching the entity type
`status`	string	Current state when this event triggered
`user`	object	User context
`order`	object	Order context

Example Payload

{
  "eventId": "evt_abc123",
  "entityType": "order",
  "entityId": "ord_xyz789",
  "status": "fund_settled",
  "user": {
    "id": "usr_001",
    "email": "customer@example.com",
    "firstName": "Jane",
    "lastName": "Doe"
  },
  "order": {
    "id": "ord_xyz789",
    "amount": "100.00",
    "currency": "USD",
    "paymentMethod": "bank_transfer"
  }
}

Was this page helpful?