Event Types

View Available Webhooks

Users can access various webhooks through a subscription service. This endpoint provides a list of all available webhooks along with the necessary details for subscription. To view available webhooks, initiate a GET request directed to the following endpoint:

https://cubi-sandbox-api.customersbank.com/webhooks/v1/EventTypes

This request requires the additional data to be included in the query of the request.

Query Parameter Data Element Details:

NameTypeDescription
paginateResultsbooleanindicates whether the request should be paginated
pageint32indicates the page to return
perPageint32indicates how many items are on a pages
sortOnstringindicates the attribute by which the data is sorted
sortAscendingbooleanindicates if the data is sorted in ascending or descending order

Example Request:

GET //webhooks/v1/eventtypes?paginateResults=false HTTP/1.1
Host: cubi-sandbox-api.customersbank.com
Authorization: Bearer ***** 

A successful request will generate a response of 200 – Success.

[
    "partner.partner.wires.enabled",
    "accounts.account-deleted",
    "accounts.account-frozen",
    "transfers.account-link-removed",
    "transfers.account-link-approved",
    "transfers.account-link-declined",
    "transfers.addressbook-entry-incoming-request",
    "accounts.account-unfrozen",
    "partner.account.entitlement-changed",
    "accounts.account-added",
    "transfers.book-approved",
    "transfers.book-completed",
    "consumerlending.loanapplication-created",
    "consumerlending.loanapplication-received",
    "consumerlending.loanapplication-rejected",
    "consumerlending.partnerprogram-added",
    "consumerlending.partnerprogram-deleted",
    "consumerlending.partnerprogram-updated",
    "accounts.account-not-found",
    "transfers.book-declined",
    "accounts.ibs-account-already-associated",
    "fednow.incoming-received",
    "rtp.incoming-received",
    "wires.incoming-received",
    "partners.partner-created",
    "partners.partner-deactivated",
    "partners.partner-deleted",
    "partners.partner-frozen",
    "partners.partner-unfrozen",
    "partners.partner-updated",
    "transfers.book-received",
    "transfers.book-rejected",
    "transfers.book-initiated",
    "transfers.book-requires-approval",
    "internal-partners.user-created",
    "partner.user-deleted",
    "partners.user-frozen",
    "partners.user-unfrozen",
    "ach.outgoing-cancelled",
    "ach.outgoing-completed",
    "ach.outgoing-initiated",
    "ach.outgoing-pending",
    "ach.outgoing-returned",
    "fednow.outgoing-completed",
    "fednow.outgoing-initiated",
    "fednow.outgoing-pending",
    "rtp.outgoing-completed",
    "rtp.outgoing-initiated",
    "rtp.outgoing-pending",
    "wires.outgoing-accepted",
    "wires.outgoing-cancelled",
    "wires.outgoing-completed",
    "wires.outgoing-initiated",
    "wires.outgoing-pending",
    "wires.outgoing-rejected",
    "wires.outgoing-returned",
    "partner.partner.wires.disabled",
    "partner.user.xfer.disabled",
    "accounts.transaction-posted",
    "partner.account.wires.enabled",
    "partner.account.xfer.enabled"
]

Response Data Element Details:

NameTypeDescription
pageSizeint32number of items displayed on a page
pageOffsetint32offset index indicating starting point for page items
totalPagesint32total number of pages
totalItemCountint32total count of items across all pages
itemsarray of strings | nullitems model

Error Handling:
Common errors will include:
400 – Bad Request
401 – Unauthorized
403 – Forbidden
404 – Not Found
422 – Client Error

For guidance on troubleshooting error codes please consult the Error Code Handling section of this guide.