Event Store (1.0.0)

Download OpenAPI specification:Download

Save New Event(s)

Saves new event(s) of specific type into the event store. When saving multiple events, the order in which they were provided is preserved in the event store.

path Parameters
eventType
required
string
Example: "cart-item-added"

type of an event

Request Body schema: application/json
Array
eventId
string
data
object

Responses

200

Returns success status and IDs of the events that were successfully saved.

400

Returns detailed error explanation in case client submitted invalid data to the event store

500

Returns detailed error explanation in case event store was unable to fulfil the request

post /events/{eventType}
https://api.example.com/v1/events/{eventType}

Request samples

application/json
Copy
Expand all Collapse all
[
  • {
    },
  • {
    }
]

Response samples

application/json
Copy
Expand all Collapse all
{
  • "eventIds":
    [
    ]
}

Get N events since eventId

get the event with a specified ID and N-1 additional events after it from a sequential batch of events where all events have the specified eventType type.

path Parameters
eventType
required
string
Example: "cart-item-added"

type of the events

query Parameters
since
required
string
Example: "af04e7c0-1a57-44bc-81a4-d8b3fd0f0f56"

the eventId of the event to be the first event in the batch of events returned. Events are ordered chronologically.

count
integer

maximum number of events to return (including the "since" one)

Responses

200

success returns list of events with details

get /events/{eventType}
https://api.example.com/v1/events/{eventType}

Response samples

application/json
Copy
Expand all Collapse all
[
  • {
    },
  • {
    },
  • {
    }
]