Event API¶
These endpoints will allow you to retrieve events from Event Store.
Get the list of events¶
To retrieve a paginated list of events, you need to call the /api/event
endpoint with the GET
method.
Definition¶
GET /api/event
Parameter | Parameter type | Description |
---|---|---|
Authorization | header | Token received during authentication |
fromId | query | (optional) Start from event ID, by default from the beginning. |
perPage | query | (optional) Number of items to display per page, by default = 10 |
sort | query | (optional) Sort by column name, by default = name |
direction | query | (optional) Direction of sorting [ASC, DESC], by default = ASC |
Example¶
curl http://localhost:8181/api/event \
-X "GET" \
-H "Accept: application/json" \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6..."
Note
The eyJhbGciOiJSUzI1NiIsInR5cCI6… authorization token is an example value. Your value may be different. Read more about Authorization here.
Note
Endpoint will return the first 100 items from the given <eventId>
.
Example Response¶
STATUS: 200 OK
{
"events": [
{
"id": 1,
"uuid": "e5fbe6a2-18f6-4569-8c5c-8f87c7717d87",
"payload": {
"accountId": {
"accountId": "e5fbe6a2-18f6-4569-8c5c-8f87c7717d87"
},
"pointsTransfer": {
"id": {
"pointsTransferId": "e82c96cf-32a3-43bd-9034-4df343e5f333"
},
"comment": "Example comment",
"createdAt": "2020-10-15T12:06:38+02:00",
"value": 100,
"canceled": false,
"issuer": "system"
}
},
"type": "OpenLoyalty.Domain.Account.Event.PointsWereSpent",
"recorderOn": "2020-10-15T10:06:38+00:00"
}
],
"total": 1
}
Get event details¶
To retrieve the details of a event, you need to call the /api/event/<eventId>
endpoint with the GET
method.
Definition¶
GET /api/event/<eventId>
Parameter | Parameter type | Description |
---|---|---|
Authorization | header | Token received during authentication |
<eventId> | query | Event ID |
Example¶
To see the details of the event with id eventId = 212333
, use the method below:
curl http://localhost:8181/api/event/212333 \
-X "GET" \
-H "Accept: application/json" \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6..."
Note
The eyJhbGciOiJSUzI1NiIsInR5cCI6… authorization token is an example value. Your value may be different. Read more about Authorization here.
Example Response¶
STATUS: 200 OK
{
"id": 73,
"uuid": "00000000-0000-474c-b092-b0dd880c07e2",
"payload": {
"customerId": {
"customerId": "00000000-0000-474c-b092-b0dd880c07e2"
},
"levelId": {
"levelId": "e82c96cf-32a3-43bd-9034-4df343e51111"
},
"oldLevelId": {
"levelId": "e82c96cf-32a3-43bd-9034-4df343e50000"
},
"updateAt": "2020-10-15T12:06:23+02:00",
"manually": false,
"removeLevelManually": false
},
"type": "OpenLoyalty.Domain.User.Event.CustomerWasMovedToLevel",
"recorderOn": "2020-10-15T10:06:23+00:00"
}
List of available events¶
OpenLoyalty.Domain.User.Event.AssignedAccountToCustomer OpenLoyalty.Domain.User.Event.AssignedTransactionToCustomer OpenLoyalty.Domain.User.Event.CampaignCouponWasChanged OpenLoyalty.Domain.User.Event.CampaignStatusWasChanged OpenLoyalty.Domain.User.Event.CampaignUsageWasChanged OpenLoyalty.Domain.User.Event.CampaignWasBoughtByCustomer OpenLoyalty.Domain.User.Event.CampaignWasReturned OpenLoyalty.Domain.User.Event.CustomerAddressWasUpdated OpenLoyalty.Domain.User.Event.CustomerAvatarWasRemoved OpenLoyalty.Domain.User.Event.CustomerAvatarWasSet OpenLoyalty.Domain.User.Event.CustomerCompanyDetailsWereUpdated OpenLoyalty.Domain.User.Event.CustomerDetailsWereUpdated OpenLoyalty.Domain.User.Event.CustomerInvitationTokenWasCreated OpenLoyalty.Domain.User.Event.CustomerLevelWasRecalculated OpenLoyalty.Domain.User.Event.CustomerLoyaltyCardNumberWasUpdated OpenLoyalty.Domain.User.Event.CustomerWasActivated OpenLoyalty.Domain.User.Event.CustomerWasAnonymized OpenLoyalty.Domain.User.Event.CustomerWasAssignedToStore OpenLoyalty.Domain.User.Event.CustomerWasAttachedToInvitation OpenLoyalty.Domain.User.Event.CustomerWasDeactivated OpenLoyalty.Domain.User.Event.CustomerWasDeleted OpenLoyalty.Domain.User.Event.CustomerWasMovedToLevel OpenLoyalty.Domain.User.Event.CustomerWasRegistered OpenLoyalty.Domain.User.Event.InvitationWasCreated OpenLoyalty.Domain.User.Event.PosWasAssignedToCustomer OpenLoyalty.Domain.User.Event.SellerWasAssignedToCustomer OpenLoyalty.Domain.Account.Event.AccountWasAssignedToStore OpenLoyalty.Domain.Account.Event.AccountWasCreated OpenLoyalty.Domain.Account.Event.PointsHasBeenReset OpenLoyalty.Domain.Account.Event.PointsTransferHasBeenCanceled OpenLoyalty.Domain.Account.Event.PointsTransferHasBeenExpired OpenLoyalty.Domain.Account.Event.PointsTransferHasBeenUnlocked OpenLoyalty.Domain.Account.Event.PointsWereAdded OpenLoyalty.Domain.Account.Event.PointsWereBlocked OpenLoyalty.Domain.Account.Event.PointsWereReturned OpenLoyalty.Domain.Account.Event.PointsWereSpent OpenLoyalty.Domain.Account.Event.PointsWereTransferred OpenLoyalty.Domain.Campaign.Event.CampaignBoughtDeliveryStatusWasChanged OpenLoyalty.Domain.Campaign.Event.CampaignBoughtCashbackStatusWasChanged OpenLoyalty.Domain.Campaign.Event.CampaignUsageWasChanged OpenLoyalty.Domain.Transaction.Event.TransactionWasRegistered OpenLoyalty.Domain.Transaction.Event.CustomerWasAssignedToTransaction