Skip to main content

Event Types

The following outlines the event types currently supported for export within the HaaS environment.

Adapter (Called by both Authorisation and Data API)​

EventDescriptionMessage
AdapterUpstreamCallEventThis event occurs for all data adapter calls. Separate to the CDR data sharing focused calls in Data API.Adapter call to {endpoint}
AdapterUpstreamFailedEventThis event occurs if an upstream adapter call failsUpstream call to {endpoint} failed: {message}

Samples​

{
"@class":"io.biza.adapter.events.AdapterUpstreamCallEvent",
"interactionId":"0bf807d7-09a8-41ac-92e8-bdc22800ed94",
"level":"INFO",
"time":"2024-02-21T04:13:21.771925543Z",
"endpointId":"getHealth",
"siemDetails":{},
"fullMessage":"Adapter call to getHealth"
}
{
"@class": "io.biza.adapter.events.AdapterUpstreamCallEvent",
"interactionId": "08bf2c71-87ea-4674-af22-dae7e2e0164e",
"level": "INFO",
"time": "2024-02-20T22:59:51.141707Z",
"endpointId": "getUser",
"siemDetails": {
"interactionId": "08bf2c71-87ea-4674-af22-dae7e2e0164e",
"xFapiCustomerIp": null,
"xFapiAuthDate": null,
"cdsClientHeaders": null,
"userId": "harry-smith",
"principalId": "214Leq0HRwVzXf7UaagqfoHnvPAJnlDk"
},
"fullMessage": "Adapter call to getUser"
}
{
"@class": "io.biza.adapter.events.AdapterUpstreamFailedEvent",
"interactionId": "75ab3e0e-e50a-4301-8a41-2834231bcf97",
"level": "INFO",
"time": "2024-02-21T04:39:46.813674282Z",
"endpointId": "getUser",
"message": "Endpoint Error for getUser",
"siemDetails": {
"interactionId": "78e6c02e-1d20-43fa-afac-d479e15b78d8",
"xFapiCustomerIp": null,
"xFapiAuthDate": null,
"cdsClientHeaders": null,
"userId": "d061f35b-4840-4227-8b31-257e029040fc-0",
"principalId": "59643d6c-7470-4ef3-a543-229776e6ccb7"
},
"fullMessage": "Upstream call to getUser failed: Endpoint Error for getUser"
}

Authorisation​

EventDescriptionMessage
ClientCreateEventThis event occurs when an ADR creates a brand new client registration to the authorisation server.Creating client with ID: [{clientId}] in realm: [{realmName}]
ClientGetEventThis event occurs when an ADR retrieves the details of their client registration.Getting client with ID: [{clientId}], in realm: [{realmName}].
ClientUpdateEventThis event occurs when an ADR updates their client registration.Updating client with ID: [{clientId}] in realm: [{realmName}].
ClientDeleteEventThis event occurs when an ADR deletes their client registration.Deleting client with ID: [{clientId}] in realm: [{realmName}]
ClientVerifyRegistrationEventThis event occurs when the DCR handlers process an client registration and validate that the SSA is from the register and correct.Verifying registration in realm: [{realmName}]
GrantAccessTokenIssuanceEventThis event occurs when an access token is issued.Short term access credentials issued till {} with the following scopes {}",expiry.toString(), String.join(",", scopes)
GrantClientCredentialsCreationEventThis event occurs when a client credentials grant is created.Established new Client Credentials Grant for Client Identifier of {} and scopes {} to expire at {}", clientId, String.join(",",scopes), expiry.toString()
GrantClientCredentialsExpirationResetEventThis event occurs when a client credentials grant expires.Client Credentials Grant for client {} reset expiration time to {}", clientId, expiry
GrantClientCredentialsScopesUpdateEventThis event occurs when the scopes are updated for a client credentials grant .Client Credentials Grant for client {} triggered assigned scopes to change to {}", clientId, String.join(",",scopes)
GrantCodeClaimedEventThis event occurs when a client credentials grant claims a code.Code claimed and initial access credentials issued with the following scopes: {}", String.join(",", scopes)
GrantCreationEventThis event occurs when a grant consent is established.Initial Consent Established with expiry set to {}", expiry
GrantHeldViaRegisterUpdateEventThis event occurs when a grant’s software product is marked inactive by the register while the grant is active, deactivating the grant.Agreement held due to Software Product '{}' being made inactive by register.", softwareProductId()
GrantIdTokenIssuanceEventThis event occurs when identity information credentials are issued.Identity information credentials issued
GrantReactivatedViaRegisterUpdateEventThis event occurs when a grant’s software product is marked active by the register, reactivating the grant.Agreement reactivated due to Software Product '{}' being made active by register.", softwareProductId()
GrantRefreshTokenIssuanceEventThis event occurs when a refresh token is issued to a grant.Ongoing access credentials issued till {} with the following scopes: {}", expiry.toString(), String.join(",", scopes)
GrantRevokedByAdminEventThis event occurs when a grant is revoked via an administrator UI.Agreement revoked by admin ui
GrantRevokedByDashboardEventThis event occurs when a grant is revoked via the dashboard.Agreement revoked by consumer dashboard
GrantRevokedByRecipientEventThis event occurs when a data recipient revokes a grant.Agreement revoked by data recipient
GrantRevokedViaRegisterUpdateEventThis event occurs when a grant’s software product is revoked, revoking the grant.Agreement revoked due to Software Product '{}' being revoked by register.", softwareProductId()

Samples​

info

This is not an exhaustive set of examples, as there is a lot of repetition in the events.

{
"@class": "io.biza.wikkitgate.auth.events.ClientGetEvent",
"interactionId": "d1ded069-aeaa-4758-99a0-ddfdadaaeff2",
"level": "INFO",
"time": "2024-02-21T02:47:58.873245Z",
"realm": "azibnrg-auth",
"clientId": "2LeZjCrgBDcrzq6LCbj2DR",
"fullMessage": "Getting client with ID: [2LeZjCrgBDcrzq6LCbj2DR], in realm: [azibnrg-auth]."
}
{
"@class": "io.biza.wikkitgate.auth.events.ClientUpdateEvent",
"interactionId": "243842c9-6107-4804-9659-77b885dfc10c",
"level": "INFO",
"time": "2024-02-21T00:48:43.754979724Z",
"clientName": "78jvWg9ynYN2QedmSDqBP5",
"realmName": "azibnrg-auth",
"redirectUris": [
"https://og-cdr.biza-og-dev.runtimes.2492.au/cdd20f15-fadb-4dec-9394-1928c680d1bf/return",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_3/callback",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_3/callback?dummy1=lorem&dummy2=ipsum",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_4/callback",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_1/callback?dummy1=lorem&dummy2=ipsum",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_2/callback",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_2/callback?dummy1=lorem&dummy2=ipsum",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_6/callback?dummy1=lorem&dummy2=ipsum",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_5/callback?dummy1=lorem&dummy2=ipsum",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_5/callback",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_1/callback",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_4/callback?dummy1=lorem&dummy2=ipsum",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_6/callback"
],
"scopes": [
"bank:accounts.detail:read",
"bank:accounts.basic:read",
"energy:electricity.usage:read",
"energy:electricity.servicepoints.detail:read",
"openid",
"bank:transactions:read",
"common:customer.detail:read",
"profile",
"energy:accounts.basic:read",
"common:customer.basic:read",
"energy:accounts.paymentschedule:read",
"bank:regular_payments:read",
"energy:billing:read",
"bank:payees:read",
"cdr:registration",
"energy:accounts.detail:read",
"energy:electricity.der:read",
"energy:electricity.servicepoints.basic:read",
"energy:accounts.concessions:read"
],
"fullMessage": "Updating client with name: [78jvWg9ynYN2QedmSDqBP5], in realm: [azibnrg-auth]."
}
{
"@class": "io.biza.wikkitgate.auth.events.ClientVerifyRegistrationEvent",
"interactionId": "26949b4e-9278-46e5-89c0-e9f0cc1a3ad5",
"level": "INFO",
"time": "2024-02-21T00:48:43.610313367Z",
"realmName": "azibnrg-auth",
"redirectUris": [
"https://og-cdr.biza-og-dev.runtimes.2492.au/cdd20f15-fadb-4dec-9394-1928c680d1bf/return",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_3/callback",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_3/callback?dummy1=lorem&dummy2=ipsum",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_4/callback",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_1/callback?dummy1=lorem&dummy2=ipsum",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_2/callback",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_2/callback?dummy1=lorem&dummy2=ipsum",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_6/callback?dummy1=lorem&dummy2=ipsum",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_5/callback?dummy1=lorem&dummy2=ipsum",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_5/callback",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_1/callback",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_4/callback?dummy1=lorem&dummy2=ipsum",
"https://biza-cdr-testing.sf.hit.692265.net.au/test/a/alias_6/callback"
],
"scopes": null,
"fullMessage": "Verifying registration in realm: [azibnrg-auth]."
}
{
"@class": "io.biza.wikkitgate.auth.events.GrantCodeClaimedEvent",
"interactionId": "ce73bae7-a11d-4f77-bfc5-b48c1d3f809a",
"level": "INFO",
"time": "2024-02-20T22:59:40.341377Z",
"grantId": "24b9bbfd-c9f7-481c-835d-f8f39c5efb3d",
"scopes": [
"Account and plan details",
"Electricity connection",
"Name and occupation",
"Concessions and assistance",
"Energy generation and storage",
"Accounts and plans",
"Contact details",
"Billing payments and history",
"Payment preferences",
"OpenID Connect",
"Electricity meter",
"Electricity usage"
],
"fullMessage": "Code claimed and initial access credentials issued with the following scopes: Account and plan details,Electricity connection,Name and occupation,Concessions and assistance,Energy generation and storage,Accounts and plans,Contact details,Billing payments and history,Payment preferences,OpenID Connect,Electricity meter,Electricity usage"
}
{
"@class": "io.biza.wikkitgate.auth.events.GrantIdTokenIssuanceEvent",
"interactionId": "f67890bc-f9fa-44e0-9b59-e511084396bf",
"level": "INFO",
"time": "2024-02-20T22:59:39.300372Z",
"grantId": "24b9bbfd-c9f7-481c-835d-f8f39c5efb3d",
"fullMessage": "Identity information credentials issued"
}
{
"@class":"io.biza.wikkitgate.auth.events.GrantAccessTokenIssuanceEvent",
"interactionId":"479e1289-29d2-44c4-beb4-9ab35e99b575",
"level":"INFO",
"time":"2024-02-21T04:15:58.485930357Z",
"grantId":"cfaf33d8-4bf8-4474-b634-be6c2e726a7d",
"realm":"azibbank-auth",
"scopes":["admin:metrics.basic:read"],
"expiry":"2024-02-21T04:25:58.437059928Z",
"fullMessage":"Short term access credentials issued till 2024-02-21T04:25:58.437059928Z with the following scopes: admin:metrics.basic:read"
}
{
"@class":"io.biza.wikkitgate.auth.events.GrantClientCredentialsExpirationResetEvent",
"interactionId":"617e6f59-8f7b-4b76-a410-126e5081645a",
"level":"INFO",
"time":"2024-02-21T04:15:45.191914136Z",
"grantId":"cfaf33d8-4bf8-4474-b634-be6c2e726a7d",
"realm":"azibbank-auth",
"clientId":"cdr-register",
"expiry":"2024-02-21T04:25:45.185378947Z",
"fullMessage":"Client Credentials Grant for client cdr-register reset expiration time to 2024-02-21T04:25:45.185378947Z"
}
{
"@class": "io.biza.wikkitgate.auth.events.GrantCreationEvent",
"interactionId": "0b79cb11-8de4-470c-9b90-a1c301a51129",
"level": "INFO",
"time": "2024-02-21T02:56:03.474501905Z",
"grantId": "9213536e-1445-4362-af39-14de482fc299",
"realm": "azibbank-auth",
"realmUserID": "e50828f5-5a8a-41fe-af5e-998973334d0e",
"realmPrincipal": "e50828f5-5a8a-41fe-af5e-998973334d0e",
"expiry": "2025-02-20T02:56:00Z",
"fullMessage": "Initial Consent Established with expiry set to 2025-02-20T02:56Z"
}
{
"@class": "io.biza.wikkitgate.auth.events.GrantRevokedByRecipientEvent",
"interactionId": "32970e86-cea5-42e0-baba-41070b58fec4",
"level": "INFO",
"time": "2024-02-21T02:56:04.804419332Z",
"grantId": "9213536e-1445-4362-af39-14de482fc299",
"realm": "azibbank-auth",
"fullMessage": "Agreement revoked by data recipient"
}

Data API​

EventIndustryDescriptionMessageSIEM Detail Fields
AccountIdentifierNotFoundEventALLThis event occurs when the pairwise internal ID for the customer is not found in pairwise DB.Specified account identifier not found.customer, userId, interactionId
GetAccountDetailsEventBANKINGThis event occurs when retrieving details for a customers account.Getting account details for customer account.customer, userId, interactionId, account
GetBankingAccountBalancesEventBANKINGThis event occurs when retrieving a balance for a customers account.Getting banking balance for customer account.customer, userId, interactionId, account
GetCustomerDetailsEventALLThis event occurs when retrieving details of a customer.Getting details of customer.customer, userId, interactionId
GetCustomerTransactionEventBANKINGThis event occurs when retrieving transaction details from a customers account.Retrieving transactions for customer account.customer, userId, interactionId, account, transaction
GetDERForServicePointEventENERGYThis event occurs when retrieving DER records for a single service point.Getting DER for a specific service point.interactionId, servicePointId
GetDERForServicePointsEventENERGYThis event occurs when retrieving DER records for multiple service points.Getting DER for a specific set of service pointsinteractionId, servicePointIds
GetEnergyAccountBalanceEventENERGYThis event occurs when retrieving the account balance for an energy account.Getting balance for energy accountcustomer, userId, interactionId, account
GetEnergyAccountPaymentScheduleEventENERGYThis event occurs when retrieving the payment schedules for an energy account.Getting payment schedule for energy accountcustomer, userId, interactionId, account
GetFRMPDetailsEventENERGYThis event occurs when retrieving the FRMP details for a list of NMIs.Getting FRMP details of service pointscustomer, userId, interactionId, servicePointIds, oldestDate
GetPayeeDetailsBankingThis event occurs when retrieving the details of a payee to a customer.Get payee details for customer.customer, userId, interactionId, payee
GetServicePointUsageEventENERGYThis event occurs when listing energy usage for a service point.Getting service point usage.interactionId, servicePointId
ListAccountBillingTransactionsEventENERGYThis event occurs when listing transactions for an energy account.List energy account billing transactionscustomer, userId, interactionId, account, oldestTime, newestTime
ListAccountIdsEventBANKINGThis event occurs when retrieving a list of accounts belonging a customer.List account IDs for customer.customer, userId, interactionId
ListAccountInvoicesEventENERGYThis event occurs when retrieving invoices for an energy account.List energy account invoices.customer, userId, interactionId, account, oldestDate, newestDate
ListAccountsEventBANKINGThis event occurs when retrieving a list of accounts for a request.List accounts for customer.customer, userId, interactionId
ListDirectDebitsEventBANKINGThis event occurs when retrieving a list of direct debits for a customer.List direct debits for customer.customer, userId, interactionId
ListEnergyAccountConcessionsEventENERGYThis event occurs when retrieving the concessions for an energy account.List energy account concessionscustomer, userId, interactionId, account
ListEnergyAccountsBalancesEventENERGYThis event occurs when listing balances for energy accounts.List energy account balancescustomer, userId, interactionId, account
ListPayeesEventBANKINGThis event occurs when retrieving a list of a payees for a customer.List payees for a customer.customer, userId, interactionId
ListScheduledPaymentEventBANKINGThis event occurs when retrieving a list of scheduled payments for a customer.List scheduled payments for customer accounts.customer, userId, interactionId
ListServicePointsEventENERGYThis event occurs when retrieving a list of service points for energy accounts.List service pointsinteractionId, servicePointIds
ListTransactionsUpstreamEventBANKINGThis event occurs when retrieving a list of transactions for a customers account.List scheduled payments for customer accounts.customer, userId, interactionId, accounts
RequestTransactionIdDoesNotMatchAdapterEventBANKINGThis event occurs when the transaction ID found in a getTransactionDetail call does not match the transaction ID found in the request.Request transaction id does not match transaction id returned by adapter.customer, userId, interactionId, account
SpecifiedPayeeIdentifierNotFoundEventBANKINGThis event occurs when the provided payee ID cannot be found.Specified payee identifier not found.customer, userId, interactionId, payee
SpecifiedTransactionDetailNotFoundEventBANKINGThis event occurs when the provided transaction ID cannot be found.Specified transaction detail not found.customer, userId, interactionId, account, transaction

Samples​

info

This is not an exhaustive set of examples, as there is a lot of repetition in the events.

{
"@class": "io.biza.adapter.events.ListTransactionsUpstreamEvent",
"interactionId": "e34433ea-780a-4c52-a960-4b207e4dcea7",
"level": "INFO",
"time": "2024-02-21T04:36:49.532153Z",
"siemDetails": {
"customer": {
"ppid": "a3ba1a35-6ad3-44cd-b472-f5c8ac2c65e6",
"ppidCustomerId": "",
"counterParty": "cdn.adr.com"
},
"userId": {
"ppid": "cb8ed82d-d955-4d8b-a3e7-bb731dd9be42",
"ppidCustomerId": "",
"counterParty": "cdn.adr.com"
},
"account": {
"ppid": "38f02bc1-f636-48a0-9790-c2b1f48c30c2",
"ppidCustomerId": "a3ba1a35-6ad3-44cd-b472-f5c8ac2c65e6",
"counterParty": "cdn.adr.com"
},
"interactionId": "e34433ea-780a-4c52-a960-4b207e4dcea7",
"xFapiCustomerIp": null,
"xFapiAuthDate": null,
"cdsClientHeaders": null
},
"upstreamFiltered": false,
"fullMessage": "List transactions for customer accounts."
}
{
"@class": "io.biza.adapter.events.GetDERForServicePointsEvent",
"interactionId": "4068406a-d70c-426c-972c-fb6013ddc26a",
"level": "INFO",
"time": "2024-02-21T02:55:52.316714Z",
"siemDetails": {
"servicePointIds": [
{
"ppid": "i1LaZaZeWJg06TY5_B560Q==",
"ppidCustomerId": "",
"counterParty": "consent.exampleadr.com"
}
],
"interactionId": "d29f9cee-ec94-4dfb-8cd5-8d9d7dc6b91c",
"arrangement": "012969fd-f25a-4b5d-b486-a2bf5b9df3d3"
},
"fullMessage": "Getting DER for a specific set of service points."
}
{
"@class": "io.biza.adapter.events.ListEnergyAccountsEvent",
"interactionId": "b617d17f-b6bd-4ef6-9237-0fc473d4a2df",
"level": "INFO",
"time": "2024-02-21T02:56:04.549615045Z",
"siemDetails": {
"customer": {
"ppid": "c96cffc7-6630-4dcb-98cd-08de8f075758",
"ppidCustomerId": "",
"counterParty": "og-cdr.biza-og-dev.runtimes.2492.au"
},
"userId": {
"ppid": "c96cffc7-6630-4dcb-98cd-08de8f075758",
"ppidCustomerId": "",
"counterParty": "og-cdr.biza-og-dev.runtimes.2492.au"
},
"accounts": [
{
"ppid": "f7c28ee8-185d-4a86-aec8-ea721a5ceddd",
"ppidCustomerId": "c96cffc7-6630-4dcb-98cd-08de8f075758",
"counterParty": "og-cdr.biza-og-dev.runtimes.2492.au"
},
{
"ppid": "70cdba73-4cc3-4fc1-8a43-ac9463d98d74",
"ppidCustomerId": "c96cffc7-6630-4dcb-98cd-08de8f075758",
"counterParty": "og-cdr.biza-og-dev.runtimes.2492.au"
}
],
"interactionId": "25c8fc1d-70c8-4eee-ad31-1167d4f8aa1c",
"xFapiCustomerIp": "198.51.100.119",
"xFapiAuthDate": "Wed, 21 Feb 2024 02:56:04 GMT",
"cdsClientHeaders": "TW96aWxsYS81LjAgKFgxMTsgTGludXggeDg2XzY0KSBBcHBsZVdlYktpdC81MzcuMzYgKEtIVE1MLCBsaWtlIEdlY2tvKSBDaHJvbWUvNzkuMC4zOTQ1Ljg4IFNhZmFyaS81MzcuMzY="
},
"fullMessage": "List energy accounts."
}