python-3.xbanno-digital-toolkit

Deep Links in Banno Admin API Alerts (Python 3.12, requests)


I am attempting to create an automated pre-collection alert using the Banno Admin API > Send Alerts endpoint: https://jackhenry.dev/open-api-docs/admin-api/api-reference/v0/alerts/details/#/Send%20Alerts/post_a_mobile_api_v0_institutions__institutionId__users__userId__alert_send_generic

The intent is to notify users of late payments and overdrawn Accounts prior to entering a collection queue (notify the user to request payment prior to manual outreach). We would like to include a button/link that takes the user to the Account referenced in the Alert.

Based on the API docs, it appears the DeepLink schema supports:

- Account: 
           - /users/userId/accounts/accountId

I'm able to successfully send a generic alert (alertId returned in response; the user receives the Alert as a push notification, and the message appears in the user's inbox). However, I don't understand how to leverage the deep link.

Code sample (Python 3.12):

BASE_URL = "https://banno.com"
user_id = [Banno Customer UUID]
account_id = [Banno Customer Account UUID]
dm.access_token = [access token obtained from client credentials flow]

response = requests.request(
    "POST",
    f"{BASE_URL}/a/mobile/api/v0/institutions/{INSTITUTION_UUID}/users/{user_id}/alert/send/generic",
    headers = {"Accept": "application/json", "Authorization": f"Bearer {dm.access_token}"},
    json = {
        "title": "Alert title",
        "message": "Message to you",
        "data": {
            "deepLink": f"/users/{user_id}/accounts/{account_id}"
        }
    }
)

The Alert the user receives only includes plain text. I feel like I'm missing something obvious, but how do I render a link/button that leverages the included deep link?

Additionally, there are only 4 deep links defined in the schema; if Banno has created institution specific deep links (ex. deep link to an external application), are those able to be utilized with the Send Alerts endpoint?

Recent attempt:

Sat, 20 Sep 2025 15:41:06 GMT
'x-request-id': '8452bdcdbf5f6d23f79d707311ba57f0'

Solution

  • Unfortunately, the deeplink parameter is not actually supported in POST /a/mobile/api/v0/institutions/{institutionId}/users/{userId}/alert/send/generic.

    We can update our docs to make this more apparent / clear.