All events delivered by the Aritma Events API follow the CloudEvents v1.0 specification — an open standard for describing event data in a common way.
Every event includes these standard CloudEvents attributes:
| Attribute | Type | Description |
|---|---|---|
specversion | String | CloudEvents spec version, always "1.0" |
id | String | Unique identifier for this event |
source | String | The subscription identifier from which the event originated |
type | String | The event type (e.g. banking.account.transaction.received) |
time | Timestamp | When the event occurred, in RFC 3339 format |
subject | String | Resource path identifying the subscription, resource group, and account |
tid | String | Tenant identifier |
Event types vary by product. Refer to each product's documentation for the full list of available event types.
{
"id": "2d59f3a8-c714-4b6e-a501-e89b04c26d73",
"source": "kx9mp3rw2jf5nt42",
"type": "banking.payment.status.updated",
"data": {
"paymentId": "p1p29af3266fa11f2229442000e4bce2590",
"endToEndIdentification": "d4e5f6a7-82c9-4b01-a3d8-fc9e7f330ab1",
"transactionStatus": "PDNG",
"tppMessages": [],
"_links": {
"bulkPayment": {
"href": "https://banking.aritma.io/api/bulk-payments/credit-transfer/p1b28af3266fa11f2229442000e4bce2590",
"verb": "get"
},
"self": {
"href": "https://banking.aritma.io/api/payments/credit-transfer/p1p29af3266fa11f2229442000e4bce2590",
"verb": "get"
}
}
},
"time": "2026-03-01T09:13:43.5146800+00:00",
"specversion": "1.0",
"subject": "/subscriptions/kx9mp3rw2jf5nt42/resource-groups/a2b4c6dw8eqrjhxk/providers/aritma.openbanking/accounts/58f63b4703ef5a47c4f276b40684d7be",
"tid": "00000000-0000-0000-0000-000000000000"
}Events are delivered to your webhook URL as HTTP POST requests using the HTTP Protocol Binding. CloudEvents attributes are included as HTTP headers prefixed with ce-:
PUT /myresource HTTP/1.1
Host: webhook.example.com
Content-Type: application/cloudevents+json; charset=utf-8
Content-Length: nnnn
{
"specversion" : "1.0",
"type" : "com.example.someevent",
... further attributes omitted ...
"data" : {
... application data ...
}
}When maxEventsPerBatch is greater than 1 in your subscription's delivery settings, multiple events are sent as a JSON array in a single request. A batch can contain different event types:
[
{
"id": "8bc942d1-6ef3-47a2-9c10-3a27d5f801e4",
"source": "kx9mp3rw2jf5nt42",
"type": "banking.payment.authorized",
"data": {
"paymentId": "p1b28af3266fa11f2229442000e4bce2590",
"authorizationId": "f65a6a2d1bb2599e336a09ef63f69230",
"userId": "b8437ce2-a0fc-4c2e-8dab-558978003411",
"requiredAuthorizations": 1,
"remainingAuthorizations": 0,
"_links": {
"self": {
"href": "https://banking.aritma.io/api/bulk-payments/credit-transfer/p1b28af3266fa11f2229442000e4bce2590",
"verb": "get"
}
}
},
"time": "2026-03-01T09:13:42.8192540+00:00",
"specversion": "1.0",
"subject": "/subscriptions/kx9mp3rw2jf5nt42/resource-groups/a2b4c6dw8eqrjhxk/providers/aritma.openbanking/accounts/58f63b4703ef5a47c4f276b40684d7be",
"tid": "00000000-0000-0000-0000-000000000000"
},
{
"id": "2d59f3a8-c714-4b6e-a501-e89b04c26d73",
"source": "kx9mp3rw2jf5nt42",
"type": "banking.payment.status.updated",
"data": {
"paymentId": "p1p29af3266fa11f2229442000e4bce2590",
"endToEndIdentification": "d4e5f6a7-82c9-4b01-a3d8-fc9e7f330ab1",
"transactionStatus": "PDNG",
"tppMessages": [],
"_links": {
"bulkPayment": {
"href": "https://banking.aritma.io/api/bulk-payments/credit-transfer/p1b28af3266fa11f2229442000e4bce2590",
"verb": "get"
},
"self": {
"href": "https://banking.aritma.io/api/payments/credit-transfer/p1p29af3266fa11f2229442000e4bce2590",
"verb": "get"
}
}
},
"time": "2026-03-01T09:13:43.5146800+00:00",
"specversion": "1.0",
"subject": "/subscriptions/kx9mp3rw2jf5nt42/resource-groups/a2b4c6dw8eqrjhxk/providers/aritma.openbanking/accounts/58f63b4703ef5a47c4f276b40684d7be",
"tid": "00000000-0000-0000-0000-000000000000"
}
]