WEBHOOKS
API Event Webhooks
API Events
7 min
api events true 235 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type event examples link created \[ { "partnerappid" "12345678", "eventid" "1495468585434 0e73d1719173766fe4dfe1a8", "eventtype" "api", "eventname" "link created", "eventtime" "2022 06 25t20 08 17 848z", "payload" { "personaltaxid" "25872252137", "businesstaxid" "", "linkid" "ed812 81fcec 7ec55 7aa7d29 2a3188b75" }, "externalinfo" { "mytraceid" "yourtraceid 1", "myuuid" "youruuid 1" } } ]true 215 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type consent authorised \[ { "partnerappid" "12345678", "eventid" "1495468585434 0e73d1719173766fe4dfe1a8", "eventtype" "api", "eventname" "consent authorised", "eventtime" "2022 06 25t20 08 17 848z", "payload" { "personaltaxid" "25872252137", "businesstaxid" "", "linkid" "ed812 81fcec 7ec55 7aa7d29 2a3188b75", "consents" { "consentid" "at932 61fc6c 0ec02 9fa7d29 2b3188b78", "externaltrackid" "222121", "institutioncode" "033", "permissionsapply" \[ "registration all", "accounts all", "credit cards all", "credit operations all", "investments all" ], "permissionsgranted" \[ "registration all", "accounts all" ], "expireat" "2024 06 25t20 08 17 848z" } }, "externalinfo" { "mytraceid" "yourtraceid 1", "myuuid" "youruuid 1" } } ]true 217 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type consent error \[ { "partnerappid" "12345678", "eventid" "1495468585434 0e73d1719173766fe4dfe1a8", "eventtype" "api", "eventname" "consent error", "eventtime" "2022 06 25t20 08 17 848z", "payload" { "personaltaxid" "25872252137", "businesstaxid" "", "linkid" "ed812 81fcec 7ec55 7aa7d29 2a3188b75", "consents" { "consentid" "at932 61fc6c 0ec02 9fa7d29 2b3188b78", "externaltrackid" "222121", "institutioncode" "033", "permissionsapply" \[ "registration all", "accounts all", "credit cards all", "credit operations all", "investments all" ], "permissionsgranted" \[], "expireat" "2024 06 25t20 08 17 848z" } }, "externalinfo" { "mytraceid" "yourtraceid 1", "myuuid" "youruuid 1" } } ]true 217 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type consent rejected \[ { "partnerappid" "12345678", "eventid" "1495468585434 0e73d1719173766fe4dfe1a8", "eventtype" "api", "eventname" "consent rejected", "eventtime" "2022 06 25t20 08 17 848z", "payload" { "personaltaxid" "25872252137", "businesstaxid" "", "linkid" "ed812 81fcec 7ec55 7aa7d29 2a3188b75", "consents" { "consentid" "at932 61fc6c 0ec02 9fa7d29 2b3188b78", "externaltrackid" "222121", "institutioncode" "033", "permissionsapply" \[ "registration all", "accounts all", "credit cards all", "credit operations all", "investments all" ], "permissionsgranted" \[], "expireat" "2024 06 25t20 08 17 848z" } }, "externalinfo" { "mytraceid" "yourtraceid 1", "myuuid" "youruuid 1" } } ]true 217 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type consent expired \[ { "partnerappid" "12345678", "eventid" "1495468585434 0e73d1719173766fe4dfe1a8", "eventtype" "api", "eventname" "consent expired", "eventtime" "2022 06 25t20 08 17 848z", "payload" { "personaltaxid" "25872252137", "businesstaxid" "", "linkid" "ed812 81fcec 7ec55 7aa7d29 2a3188b75", "consents" { "consentid" "at932 61fc6c 0ec02 9fa7d29 2b3188b78", "externaltrackid" "222121", "institutioncode" "033", "permissionsapply" \[ "registration all", "accounts all", "credit cards all", "credit operations all", "investments all" ], "permissionsgranted" \[], "expireat" "2024 06 25t20 08 17 848z" } }, "externalinfo" { "mytraceid" "yourtraceid 1", "myuuid" "youruuid 1" } } ]true 217 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type consent revoked \[ { "partnerappid" "12345678", "eventid" "1495468585434 0e73d1719173766fe4dfe1a8", "eventtype" "api", "eventname" "consent revoked", "eventtime" "2022 06 25t20 08 17 848z", "payload" { "personaltaxid" "25872252137", "businesstaxid" "", "linkid" "ed812 81fcec 7ec55 7aa7d29 2a3188b75", "consents" { "consentid" "at932 61fc6c 0ec02 9fa7d29 2b3188b78", "externaltrackid" "222121", "institutioncode" "033", "permissionsapply" \[ "registration all", "accounts all", "credit cards all", "credit operations all", "investments all" ], "permissionsgranted" \[ "registration all", "accounts all" ], "expireat" "2024 06 25t20 08 17 848z" } }, "externalinfo" { "mytraceid" "yourtraceid 1", "myuuid" "youruuid 1" } } ]true 217 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type consent deleted by user \[ { "partnerappid" "12345678", "eventid" "1495468585434 0e73d1719173766fe4dfe1a8", "eventtype" "api", "eventname" "consent deleted by user", "eventtime" "2022 06 25t20 08 17 848z", "payload" { "personaltaxid" "25872252137", "businesstaxid" "", "linkid" "ed812 81fcec 7ec55 7aa7d29 2a3188b75", "consents" { "consentid" "at932 61fc6c 0ec02 9fa7d29 2b3188b78", "externaltrackid" "222121", "institutioncode" "033", "permissionsapply" \[ "registration all", "accounts all", "credit cards all", "credit operations all", "investments all" ], "permissionsgranted" \[ "registration all", "accounts all" ], "expireat" "2024 06 25t20 08 17 848z" } }, "externalinfo" { "mytraceid" "yourtraceid 1", "myuuid" "youruuid 1" } } ] if the user revokes the consent, it may not be possible to send the event (as this depends on the open finance directory or bank) true 217 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type product request received \[ { "partnerappid" "12345678", "eventid" "1495468585434 0e73d1719173766fe4dfe1a8", "eventtype" "api", "eventname" "product request received", "eventtime" "2022 06 25t20 08 17 848z", "payload" { "personaltaxid" "25872252137", "businesstaxid" "", "requestid" "766fe4dfe1a8", "requestbody" { "taxid" "12345678901", "institutioncode" "033", "linkid" "ed812 81fcec 7ec55 7aa7d29 2a3188b75", "consentids" \[ "at932 61fc6c 0ec02 9fa7d29 2b3188b78" ], "products" \[ "pf checking account", "pf credit card" ], "productcallbackurl" { "pf checking account" "https //www yourdomain com/checking/yourpath", "pf credit card" "https //www yourdomain com/creditcard/yourpath" } } }, "externalinfo" { "mytraceid" "yourtraceid 1", "myuuid" "youruuid 1" } } ]true 221 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type product generated success \[ { "partnerappid" "12345678", "eventid" "1495468585434 0e73d1719173766fe4dfe1a8", "eventtype" "api", "eventname" "product generated success", "eventtime" "2022 06 25t20 08 17 848z", "payload" { "personaltaxid" "25872252137", "businesstaxid" "", "requestid" "766fe4dfe1a8", "product" "pf checking account" }, "externalinfo" { "mytraceid" "yourtraceid 1", "myuuid" "youruuid 1" } } ]true 221 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type product generated failed \[ { "partnerappid" "12345678", "eventid" "1495468585434 0e73d1719173766fe4dfe1a8", "eventtype" "api", "eventname" "product generated failed", "eventtime" "2022 06 25t20 08 17 848z", "payload" { "personaltaxid" "25872252137", "businesstaxid" "", "requestid" "766fe4dfe1a8", "product" "pf checking account", "failurereason" "no checking account" }, "externalinfo" { "mytraceid" "yourtraceid 1", "myuuid" "youruuid 1" } } ]true 221 unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type

