getEvents

Get all Events up to 30 days back in a paginated listing, sorted by ascending createdAt.

Query Parameters

page integer
Possible values: >= 1
Default value: 1
The page number in a paginated listing.
items integer
Possible values: >= 1 and <= 20
Default value: 20
The number of items to return on each page.
createdAfter RFC3339
Filter Events to only include those with a createdAt timestamp strictly greater than createdAfter. Useful for polling and batch processing; iterate over all Events, and filter each request by createdAt of the latest processed Event.
Example: 2023-05-07T14:21:56.123Z

Responses

All events in a paginated listing.

application/json

Schema
Example (from schema)

Schema

events object[]
Array [
oneOf
event.UserCreated
event.UserDestroyed
event.PageView
event.DepositRequested
event.DepositSettled
event.DepositFailed
event.WithdrawalRequested
event.WithdrawalSettled
event.WithdrawalFailed
event.InternalTransferRequested
event.InternalTransferSettled
event.InternalTransferFailed
event.DreamCreated
event.DreamAchieved
event.SavehackLaunched
event.DreamMilestone
type string required
Possible values: [UserCreated]
id string required
createdAt RFC3339 required
data object required
type string required
Possible values: [User]
id uuid required
externalId string
givenName string
familyName string
provisioningInitiatedAt RFC3339
unreadMessagesCount integer required
type string required
Possible values: [UserDestroyed]
id string required
createdAt RFC3339 required
data object required
type string required
Possible values: [User]
id uuid required
externalId string
givenName string
familyName string
provisioningInitiatedAt RFC3339
unreadMessagesCount integer required
deletedAt RFC3339 required
type string required
Possible values: [PageView]
id string required
createdAt RFC3339 required
data object required
user object required
type string required
id string required
externalId string
path string required
timestamp RFC3339 required
type string required
Possible values: [DepositRequested]
id string required
createdAt RFC3339 required
data object required
type string required
Possible values: [Deposit]
id string required
externalId string
transferConsentId uuid
user object required
type string required
id string required
externalId string
amountCents integer required
state string required
Possible values: [requested, settled, failed]
requestedAt RFC3339 required
settledAt RFC3339
failedAt RFC3339
toAccount object required
type string required
id string required
externalId string
toDream object
type string required
id string required
name string required
type string required
Possible values: [DepositSettled]
id string required
createdAt RFC3339 required
data object required
type string required
Possible values: [Deposit]
id string required
externalId string
transferConsentId uuid
user object required
type string required
id string required
externalId string
amountCents integer required
state string required
Possible values: [requested, settled, failed]
requestedAt RFC3339 required
settledAt RFC3339
failedAt RFC3339
toAccount object required
type string required
id string required
externalId string
toDream object
type string required
id string required
name string required
type string required
Possible values: [DepositFailed]
id string required
createdAt RFC3339 required
data object required
type string required
Possible values: [Deposit]
id string required
externalId string
transferConsentId uuid
user object required
type string required
id string required
externalId string
amountCents integer required
state string required
Possible values: [requested, settled, failed]
requestedAt RFC3339 required
settledAt RFC3339
failedAt RFC3339
toAccount object required
type string required
id string required
externalId string
toDream object
type string required
id string required
name string required
type string required
Possible values: [WithdrawalRequested]
id string required
createdAt RFC3339 required
data object required
type string required
Possible values: [Withdrawal]
id string required
externalId string
transferConsentId uuid
user object required
type string required
id string required
externalId string
amountCents integer required
state string required
Possible values: [requested, settled, failed]
requestedAt RFC3339 required
settledAt RFC3339
failedAt RFC3339
fromAccount object required
type string required
id string required
externalId string
fromDream object
type string required
id string required
name string required
type string required
Possible values: [WithdrawalSettled]
id string required
createdAt RFC3339 required
data object required
type string required
Possible values: [Withdrawal]
id string required
externalId string
transferConsentId uuid
user object required
type string required
id string required
externalId string
amountCents integer required
state string required
Possible values: [requested, settled, failed]
requestedAt RFC3339 required
settledAt RFC3339
failedAt RFC3339
fromAccount object required
type string required
id string required
externalId string
fromDream object
type string required
id string required
name string required
type string required
Possible values: [WithdrawalFailed]
id string required
createdAt RFC3339 required
data object required
type string required
Possible values: [Withdrawal]
id string required
externalId string
transferConsentId uuid
user object required
type string required
id string required
externalId string
amountCents integer required
state string required
Possible values: [requested, settled, failed]
requestedAt RFC3339 required
settledAt RFC3339
failedAt RFC3339
fromAccount object required
type string required
id string required
externalId string
fromDream object
type string required
id string required
name string required
type string required
Possible values: [InternalTransferRequested]
id string required
createdAt RFC3339 required
data object required
type string required
Possible values: [Internal]
id string required
externalId string
transferConsentId uuid
user object required
type string required
id string required
externalId string
amountCents integer required
state string required
Possible values: [requested, settled, failed]
requestedAt RFC3339 required
settledAt RFC3339
failedAt RFC3339
fromAccount object required
type string required
id string required
externalId string
fromDream object
type string required
id string required
name string required
toAccount object required
type string required
id string required
externalId string
toDream object
type string required
id string required
name string required
type string required
Possible values: [InternalTransferSettled]
id string required
createdAt RFC3339 required
data object required
type string required
Possible values: [Internal]
id string required
externalId string
transferConsentId uuid
user object required
type string required
id string required
externalId string
amountCents integer required
state string required
Possible values: [requested, settled, failed]
requestedAt RFC3339 required
settledAt RFC3339
failedAt RFC3339
fromAccount object required
type string required
id string required
externalId string
fromDream object
type string required
id string required
name string required
toAccount object required
type string required
id string required
externalId string
toDream object
type string required
id string required
name string required
type string required
Possible values: [InternalTransferFailed]
id string required
createdAt RFC3339 required
data object required
type string required
Possible values: [Internal]
id string required
externalId string
transferConsentId uuid
user object required
type string required
id string required
externalId string
amountCents integer required
state string required
Possible values: [requested, settled, failed]
requestedAt RFC3339 required
settledAt RFC3339
failedAt RFC3339
fromAccount object required
type string required
id string required
externalId string
fromDream object
type string required
id string required
name string required
toAccount object required
type string required
id string required
externalId string
toDream object
type string required
id string required
name string required
type string required
Possible values: [DreamCreated]
id string required
createdAt RFC3339 required
data object required
id uuid
targetCents integer
Represents how much money (in cents or the smallest currency subunit) the User wants to save to complete this Dream.
type string
expiresAt ISO-8601 Date (extended format with separators)
(Optional) Date before which the User wants to complete this Dream.
achievedAt RFC3339
DateTime when the dream was completed.
name string
user object
type string required
id string required
externalId string
groupDream object
(Optional) GroupDream this Dream is a part of.
type string required
id string required
account object
The Account connected to this Dream.
type string required
id string required
externalId string
type string required
Possible values: [DreamAchieved]
id string required
createdAt RFC3339 required
data object required
id uuid
targetCents integer
Represents how much money (in cents or the smallest currency subunit) the User wants to save to complete this Dream.
type string
expiresAt ISO-8601 Date (extended format with separators)
(Optional) Date before which the User wants to complete this Dream.
achievedAt RFC3339
DateTime when the dream was completed.
name string
user object
type string required
id string required
externalId string
groupDream object
(Optional) GroupDream this Dream is a part of.
type string required
id string required
account object
The Account connected to this Dream.
type string required
id string required
externalId string
type string required
Possible values: [SavehackLaunched]
id string required
createdAt RFC3339 required
data object required
oneOf
schemas-savehackLaunch.AutopilotLaunch
schemas-savehackLaunch.DailyLaunch
schemas-savehackLaunch.WeeklyLaunch
schemas-savehackLaunch.MonthlyLaunch
schemas-savehackLaunch.ThiefLaunch
schemas-savehackLaunch.RocketLaunch
schemas-savehackLaunch.OneTimeLaunch
schemas-savehackLaunch.RouletteLaunch
schemas-savehackLaunch.MoonstruckLaunch
schemas-savehackLaunch.PercentageLaunch
schemas-savehackLaunch.EverestLaunch
schemas-savehackLaunch.CalendarChaosLaunch
schemas-savehackLaunch.SaveLeagueLaunch
schemas-savehackLaunch.EurocupLaunch
schemas-savehackLaunch.CopycatLaunch
id uuid required
dream object required
type string required
id string required
savehack object required
type string required
id string required
stoppedAt RFC3339 nullable
pausedAt RFC3339 nullable
type string required
Possible values: [AutopilotLaunch]

type string required

Possible values: [DreamMilestone]

id uuid required

createdAt RFC3339 required

dream object

This field is present only in case the milestone was created not due to InternalTransfer

type string required

id string required

toDream object

This field is present only in case the milestone was created due to InternalTransfer

type string required

id string required

fromDream object

This field is present only in case the milestone was created due to InternalTransfer

type string required

id string required

user object

type string required

id string required

percentage integer nullable

Possible values: [25, 50, 75, 100]

balanceCents account.BalanceCents

Default value: 0

The total worth of all assets, in cents or the smallest currency subunit.

balanceCentsBefore account.BalanceCents

Default value: 0

The total worth of all assets, in cents or the smallest currency subunit.

]

meta object

next_url url

URL for the next page.

count integer

The total count of items.

items integer

The number of returned items on this page.

pages integer

The number of pages.

from integer

Index of the first item on this page (starting from 1).

to integer

Index of the last item on this page.

{
  "events": [
    {
      "type": "UserCreated",
      "id": "string",
      "createdAt": "2006-01-02T15:04:05Z",
      "data": {
        "type": "User",
        "id": "31566c16-c5c4-4ea2-9ec9-4708a2edec2e",
        "externalId": "10002345",
        "givenName": "Erika",
        "familyName": "Mustermann",
        "provisioningInitiatedAt": "2006-01-02T15:04:05Z",
        "unreadMessagesCount": 2
      }
    },
    {
      "type": "UserDestroyed",
      "id": "string",
      "createdAt": "2006-01-02T15:04:05Z",
      "data": {
        "type": "User",
        "id": "31566c16-c5c4-4ea2-9ec9-4708a2edec2e",
        "externalId": "10002345",
        "givenName": "Erika",
        "familyName": "Mustermann",
        "provisioningInitiatedAt": "2006-01-02T15:04:05Z",
        "unreadMessagesCount": 2,
        "deletedAt": "2006-01-02T15:04:05Z"
      }
    },
    {
      "type": "PageView",
      "id": "string",
      "createdAt": "2006-01-02T15:04:05Z",
      "data": {
        "user": {
          "type": "User",
          "id": "31566c16-c5c4-4ea2-9ec9-4708a2edec2e",
          "externalId": 10002345
        },
        "path": "/dreams/de2706a8-6853-479a-9b61-ed9d1c91010d",
        "timestamp": "2006-01-02T15:04:05Z"
      }
    },
    {
      "type": "DepositRequested",
      "id": "string",
      "createdAt": "2006-01-02T15:04:05Z",
      "data": {
        "type": "Deposit",
        "id": "c0079a71-55f1-483f-b848-19efc4ff654a",
        "externalId": "txn_12345",
        "transferConsentId": "7c5aabe3-d1f1-4e57-9874-04cac40f8a2d",
        "user": {
          "type": "User",
          "id": "cb66889a-8a8b-4d6b-81a3-fcf2340e838a",
          "externalId": "usr_12345"
        },
        "amountCents": 12350,
        "state": "settled",
        "requestedAt": "2023-03-22T10:09:15Z",
        "settledAt": "2023-03-22T10:11:56Z",
        "toAccount": {
          "type": "SharedSavings",
          "id": "b7a09ce5-7e70-42b6-b670-5e09fff9f8b0",
          "externalId": "acc_12345"
        }
      }
    },
    {
      "type": "DepositSettled",
      "id": "string",
      "createdAt": "2006-01-02T15:04:05Z",
      "data": {
        "type": "Deposit",
        "id": "c0079a71-55f1-483f-b848-19efc4ff654a",
        "externalId": "txn_12345",
        "transferConsentId": "7c5aabe3-d1f1-4e57-9874-04cac40f8a2d",
        "user": {
          "type": "User",
          "id": "cb66889a-8a8b-4d6b-81a3-fcf2340e838a",
          "externalId": "usr_12345"
        },
        "amountCents": 12350,
        "state": "settled",
        "requestedAt": "2023-03-22T10:09:15Z",
        "settledAt": "2023-03-22T10:11:56Z",
        "toAccount": {
          "type": "SharedSavings",
          "id": "b7a09ce5-7e70-42b6-b670-5e09fff9f8b0",
          "externalId": "acc_12345"
        }
      }
    },
    {
      "type": "DepositFailed",
      "id": "string",
      "createdAt": "2006-01-02T15:04:05Z",
      "data": {
        "type": "Deposit",
        "id": "c0079a71-55f1-483f-b848-19efc4ff654a",
        "externalId": "txn_12345",
        "transferConsentId": "7c5aabe3-d1f1-4e57-9874-04cac40f8a2d",
        "user": {
          "type": "User",
          "id": "cb66889a-8a8b-4d6b-81a3-fcf2340e838a",
          "externalId": "usr_12345"
        },
        "amountCents": 12350,
        "state": "settled",
        "requestedAt": "2023-03-22T10:09:15Z",
        "settledAt": "2023-03-22T10:11:56Z",
        "toAccount": {
          "type": "SharedSavings",
          "id": "b7a09ce5-7e70-42b6-b670-5e09fff9f8b0",
          "externalId": "acc_12345"
        }
      }
    },
    {
      "type": "WithdrawalRequested",
      "id": "string",
      "createdAt": "2006-01-02T15:04:05Z",
      "data": {
        "type": "Withdrawal",
        "id": "c0079a71-55f1-483f-b848-19efc4ff654a",
        "externalId": "txn_12345",
        "user": {
          "type": "User",
          "id": "cb66889a-8a8b-4d6b-81a3-fcf2340e838a",
          "externalId": "usr_12345"
        },
        "amountCents": 12350,
        "state": "settled",
        "requestedAt": "2023-03-22T10:09:15Z",
        "settledAt": "2023-03-22T10:11:56Z",
        "fromAccount": {
          "type": "SharedSavings",
          "id": "b7a09ce5-7e70-42b6-b670-5e09fff9f8b0",
          "externalId": "acc_12345"
        }
      }
    },
    {
      "type": "WithdrawalSettled",
      "id": "string",
      "createdAt": "2006-01-02T15:04:05Z",
      "data": {
        "type": "Withdrawal",
        "id": "c0079a71-55f1-483f-b848-19efc4ff654a",
        "externalId": "txn_12345",
        "user": {
          "type": "User",
          "id": "cb66889a-8a8b-4d6b-81a3-fcf2340e838a",
          "externalId": "usr_12345"
        },
        "amountCents": 12350,
        "state": "settled",
        "requestedAt": "2023-03-22T10:09:15Z",
        "settledAt": "2023-03-22T10:11:56Z",
        "fromAccount": {
          "type": "SharedSavings",
          "id": "b7a09ce5-7e70-42b6-b670-5e09fff9f8b0",
          "externalId": "acc_12345"
        }
      }
    },
    {
      "type": "WithdrawalFailed",
      "id": "string",
      "createdAt": "2006-01-02T15:04:05Z",
      "data": {
        "type": "Withdrawal",
        "id": "c0079a71-55f1-483f-b848-19efc4ff654a",
        "externalId": "txn_12345",
        "user": {
          "type": "User",
          "id": "cb66889a-8a8b-4d6b-81a3-fcf2340e838a",
          "externalId": "usr_12345"
        },
        "amountCents": 12350,
        "state": "settled",
        "requestedAt": "2023-03-22T10:09:15Z",
        "settledAt": "2023-03-22T10:11:56Z",
        "fromAccount": {
          "type": "SharedSavings",
          "id": "b7a09ce5-7e70-42b6-b670-5e09fff9f8b0",
          "externalId": "acc_12345"
        }
      }
    },
    {
      "type": "InternalTransferRequested",
      "id": "string",
      "createdAt": "2006-01-02T15:04:05Z",
      "data": {
        "type": "Internal",
        "id": "c0079a71-55f1-483f-b848-19efc4ff654a",
        "externalId": "txn_12345",
        "user": {
          "type": "User",
          "id": "cb66889a-8a8b-4d6b-81a3-fcf2340e838a",
          "externalId": "usr_12345"
        },
        "amountCents": 12350,
        "state": "settled",
        "requestedAt": "2023-03-22T10:09:15Z",
        "settledAt": "2023-03-22T10:11:56Z",
        "toAccount": {
          "type": "SharedSavings",
          "id": "b7a09ce5-7e70-42b6-b670-5e09fff9f8b0",
          "externalId": "acc_12345"
        },
        "fromAccount": {
          "type": "Performance",
          "id": "d98da36d-b963-4866-bde2-87845b7d0714",
          "externalId": "acc_12346"
        }
      }
    },
    {
      "type": "InternalTransferSettled",
      "id": "string",
      "createdAt": "2006-01-02T15:04:05Z",
      "data": {
        "type": "Internal",
        "id": "c0079a71-55f1-483f-b848-19efc4ff654a",
        "externalId": "txn_12345",
        "user": {
          "type": "User",
          "id": "cb66889a-8a8b-4d6b-81a3-fcf2340e838a",
          "externalId": "usr_12345"
        },
        "amountCents": 12350,
        "state": "settled",
        "requestedAt": "2023-03-22T10:09:15Z",
        "settledAt": "2023-03-22T10:11:56Z",
        "toAccount": {
          "type": "SharedSavings",
          "id": "b7a09ce5-7e70-42b6-b670-5e09fff9f8b0",
          "externalId": "acc_12345"
        },
        "fromAccount": {
          "type": "Performance",
          "id": "d98da36d-b963-4866-bde2-87845b7d0714",
          "externalId": "acc_12346"
        }
      }
    },
    {
      "type": "InternalTransferFailed",
      "id": "string",
      "createdAt": "2006-01-02T15:04:05Z",
      "data": {
        "type": "Internal",
        "id": "c0079a71-55f1-483f-b848-19efc4ff654a",
        "externalId": "txn_12345",
        "user": {
          "type": "User",
          "id": "cb66889a-8a8b-4d6b-81a3-fcf2340e838a",
          "externalId": "usr_12345"
        },
        "amountCents": 12350,
        "state": "settled",
        "requestedAt": "2023-03-22T10:09:15Z",
        "settledAt": "2023-03-22T10:11:56Z",
        "toAccount": {
          "type": "SharedSavings",
          "id": "b7a09ce5-7e70-42b6-b670-5e09fff9f8b0",
          "externalId": "acc_12345"
        },
        "fromAccount": {
          "type": "Performance",
          "id": "d98da36d-b963-4866-bde2-87845b7d0714",
          "externalId": "acc_12346"
        }
      }
    },
    {
      "type": "DreamCreated",
      "id": "string",
      "createdAt": "2006-01-02T15:04:05Z",
      "data": {
        "id": "844830a8-b845-4cbc-b79f-865cd8c8aa8e",
        "targetCents": 102000,
        "type": "Dream",
        "expiresAt": "2006-01-02",
        "achievedAt": "2006-01-02T15:04:05Z",
        "name": "Trip to Japan",
        "user": {
          "type": "string",
          "id": "string",
          "externalId": "string"
        },
        "groupDream": {
          "type": "string",
          "id": "string"
        },
        "account": {
          "type": "string",
          "id": "string",
          "externalId": "string"
        }
      }
    },
    {
      "type": "DreamAchieved",
      "id": "string",
      "createdAt": "2006-01-02T15:04:05Z",
      "data": {
        "id": "844830a8-b845-4cbc-b79f-865cd8c8aa8e",
        "targetCents": 102000,
        "type": "Dream",
        "expiresAt": "2006-01-02",
        "achievedAt": "2006-01-02T15:04:05Z",
        "name": "Trip to Japan",
        "user": {
          "type": "string",
          "id": "string",
          "externalId": "string"
        },
        "groupDream": {
          "type": "string",
          "id": "string"
        },
        "account": {
          "type": "string",
          "id": "string",
          "externalId": "string"
        }
      }
    },
    {
      "type": "SavehackLaunched",
      "id": "string",
      "createdAt": "2006-01-02T15:04:05Z",
      "data": {
        "id": "844830a8-b845-4cbc-b79f-865cd8c8aa8e",
        "dream": {
          "type": "string",
          "id": "string"
        },
        "savehack": {
          "type": "string",
          "id": "string"
        },
        "stoppedAt": "2006-01-02T15:04:05Z",
        "pausedAt": "2006-01-02T15:04:05Z",
        "type": "AutopilotLaunch"
      }
    },
    {
      "type": "DreamMilestone",
      "id": "844830a8-b845-4cbc-b79f-865cd8c8aa8e",
      "createdAt": "2006-01-02T15:04:05Z",
      "dream": {
        "type": "string",
        "id": "string"
      },
      "toDream": {
        "type": "string",
        "id": "string"
      },
      "fromDream": {
        "type": "string",
        "id": "string"
      },
      "user": {
        "type": "string",
        "id": "string"
      },
      "percentage": 25,
      "balanceCents": 0,
      "balanceCentsBefore": 0
    }
  ],
  "meta": true
}

getEvents​

getEvents