Events

An event is a notification payload generated through user actions, system signals, and ledger updates.

Events are the notification payloads generated through user actions, system signals, and ledger updates.

Event payloads follow a common pattern including the following fields:

id, a unique identifier for the event,
domainId, a reference to the domain where the event has been issued,
sequenceNumber, a strictly increasing sequence number (but possibly non contiguous),
savedAt, a timestamp, and
payload, additional information depending on the event type.

Operações

List events

Requisição

Segurança

httpAuth

Caminho

domainIdstring, (uuid)obrigatório

Unique identifier for the domain.

Consulta

limitinteger, (int32), [ 1 .. 100 ]

The number of entities to return.

startingAfterstring, (uuid)

Entity id used to the determine beginning of query results.

sortBystring

Property name used to sort the query results.

Value:"sequenceNumber"

sortOrderstring

Sort order applied to the query results.

Enum:"ASC""DESC"

scopestring

Return events for scope of own domain, Self (default), or including subdomains, SelfAndDescendants.

Padrão:"Self"

Enum:"Self""SelfAndDescendants"

Exemplo:scope=SelfAndDescendants

curl -i -X GET \
  'https://docs.ripple.com/_mock/pt-br/products/custody/v1.34/devbox/v1/domains/{domainId}/events?limit=1&startingAfter=497f6eca-6276-4993-bfeb-53cbbbba6f08&sortBy=sequenceNumber&sortOrder=ASC&scope=SelfAndDescendants' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respostas

Corpoapplication/json

itemsArray of objectsobrigatório

countinteger, (int32)obrigatório

currentStartingAfterstring

nextStartingAfterstring

Resposta