Evently.cloud Preview (1.2.0)

Form to register an entity event. GET the schema, create a JSON object with it and POST it back this endpoint.

Accepts a form object to register a new entity event type. This action is idempotent, so one can register the same event repeatedly without a failure response.

Information about the ledgers, including links to download and reset actions.

Download the entire ledger or the ledger after a specified ledger mark / event ID.

Submit form to download a ledger either entirely or after a ledger mark / event ID.

Download the ledger as configured by a download ledger form. The content is formatted as newline-delimited JSON and can be streamed to disk or through a streaming processor.

Create a ledger reset request with this form schema and POST it back.

Reset the ledger to remove events, either completely or after a specific point.

Get links to entities that have registered events.

Get links to events registered to an entity.

Get a registered entity event.

Deletes this entity event registration. Only succeeds if no events of this type have been appended to the ledger.

Returns a JSON Schema form to append a factual event. Create an object matching this schema and POST it back.

Append a factual event to the ledger. Factual events append without conditions such as selector state or entity sequence. Facts often capture external events like delivery service receipts and IoT signals.

If your client has uncertain connectivity and wants to append the event multiple times to ensure success, send a unique, client-created idempotencyKey to identify this specific event in subsequent append attempts. Evently recommends using Nano IDs.

Returns a JSON Schema form to append a serial event. Create an object matching this schema and POST it back.

Append a serial event to the ledger. Serial events append only if they are the next event in an entity event sequence. The form requires a previousEventId for the latest event for an entity instance. This can be obtained from the result of a previous append operation or from a replay selector result.

In order to append a serial event, an event must already be appended for the entity instance. This can be done by atomically appending a event which appends an event if none have been appended already, or a simple factual event if the client is unconcerned with other attempts to append to the specific entity instance.

If your client has uncertain connectivity and wants to append the event multiple times to ensure success, send a unique, client-created idempotencyKey to identify this specific event in subsequent append attempts. Evently recommends using Nano IDs.

Returns a JSON Schema form to atomically append and event using a selector conditional. Create an object matching this schema and POST it back.

Append an event atomically to the ledger using a selector conditional. These events append only if the provided selector is quiescent, meaning it has no new events. This selector's quiescence is the condition required to append the event. The form requires a selector object with a selectorId indicating the selector and mark pointing to the ledger mark where the selector has been read up to.

One can use either a replay or a filter selector as a condition for appending an event. The data for the selector object is found in the selector's footer object at the end of a selector event stream.

If your client has uncertain connectivity and wants to append the event multiple times to ensure success, send a unique, client-created idempotencyKey to identify this specific event in subsequent append attempts. Evently recommends using Nano IDs.

Lookup control used to select entity events to replay. Construct an object that matches this schema and POST it back to this location.

Submit a filter request to stream events from the ledger that match filter criteria. Use after to catch up on a previously-fetched selector by setting it to a ledger mark or event ID. The limit property controls how many events are returned in the selector.

This resource redirects to a URL that contains the selector results. If the redirect approach is not suitable, send a Prefer header indicating your client wishes the selector result in the POST response.

The default redirect approach works well with shared entities that change infrequently as they contain caching instructions to share with other clients. If the entity instance changes often then sending Prefer: return=representation will improve selector performance by skipping the redirect step at the cost of not utilizing the internet's caching services.

The selector footer information (selectorId, mark) can be used to atomically append events using the /append/atomic endpoint.

Lookup control used to select filtered events across all entities in the ledger. Construct an object that matches this schema and POST it back to this location.

Submit a filter selector request to stream events of specified entities from the ledger. Use after to catch up on a previously-fetched selector by setting it to a ledger mark or event ID. The limit property controls how many events are returned in the selector.

This resource redirects to a URL that contains the selector results. If the redirect approach is not suitable, send a Prefer header indicating your client wishes the selector result in the POST response.

The default redirect approach works well with shared entities that change infrequently as they contain caching instructions to share with other clients. If the entity instance changes often then sending Prefer: return=representation will improve selector performance by skipping the redirect step at the cost of not utilizing the internet's caching services.

The selector footer information (selectorId, mark) can be used to atomically append events using the /append/atomic endpoint.

Fetch a selector result as configured by a selector lookup. This resource URI is provided by replay and filter selector lookups.

This resource returns a newline-delimited JSON stream of the events, ordered by their append sequence. The last line of the response is a footer object. The footer contains data about the selector and links to selectors that will fetch all the matching events from the start of the ledger as well as a link to the current events that match the selector, but occurred after this selector was fetched.

POST an empty body to this resource to open a new notification channel.

Open a new notification channel.

Get links to events registered to an entity.

Form to subscribe to selector notifications. GET the schema, create a JSON object with it and POST it back this endpoint.

Accepts a form object to subscribe to notifications of new events that match the given selector. This action is idempotent, so one can subscribe to the same selector repeatedly without a failure response.

Get links to a channel's subscriptions.

Get a channel selector subscription.

Unsubscribes from notifications of new events that match this selector.

Listen to selector notification events. Each event is a comma-separated list of matching selectors from the subscription list. See https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events for details on how to consume this event stream.