Details

openapi: 3.0.0 info: version: '0.0' title: Alerts description: | Sending of alerts. These alerts are only sent via the push channel today. tags: - name: Send Alerts description: Send an alert - name: Alert Configuration servers: - url: 'https://banno.com' paths: '/a/mobile/api/v0/institutions/{institutionId}/users/{userId}/alert/send/generic': post: tags: - Send Alerts summary: Send a generic push alert description: Requires the "Manage institution messages" permission security: - clientCredentials: [] parameters: - $ref: '#/components/parameters/institutionIdParam' - $ref: '#/components/parameters/userIdParam' requestBody: description: | Send a simple push alert using a 'user.generic' alert type defined/configurable in the routes above. content: application/json: schema: type: object required: - title - message properties: title: type: string description: push title message: type: string description: push message body data: $ref: '#/components/schemas/PushData' skipInbox: type: boolean default: false description: (Deprecated. The functionality for this parameter is not implemented and this parameter will be removed in the future.) deprecated: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SendAlertResponse' '/a/mobile/api/v0/institutions/{institutionId}/alert/config': get: tags: - Alert Configuration summary: Get alert configurations description: Requires the "Manage security settings" permission parameters: - $ref: '#/components/parameters/institutionIdParam' responses: '200': description: OK content: application/json: schema: type: object required: - configured properties: configured: type: array items: type: object required: - alertType - available - overridable - enabled properties: alertType: $ref: '#/components/schemas/AlertType' available: type: boolean overridable: $ref: '#/components/schemas/Channels' enabled: $ref: '#/components/schemas/Channels' components: securitySchemes: clientCredentials: type: oauth2 description: OAuth2 using the client credentials flow flows: clientCredentials: tokenUrl: https://banno.com/a/oidc-provider/api/v0/token scopes: {} parameters: institutionIdParam: in: path name: institutionId required: true schema: $ref: '#/components/schemas/InstitutionId' userIdParam: in: path name: userId required: true schema: $ref: '#/components/schemas/UserId' schemas: DeepLink: type: string format: uri description: | One of the following paths that represent a best effort location relevant to the notification. - User: - /users/userId - Account: - /users/userId/accounts/accountId - Transaction: - /users/userId/accounts/accountId/transactions/transactionId - Transfer: - /users/userId/accounts/accountId/transfers/transferId PushData: type: object description: | A custom map of data that is passed back to an app with a push notification. Can use up to 2048 bytes of data. properties: deepLink: $ref: '#/components/schemas/DeepLink' SendAlertResponse: type: object required: - alertId properties: alertId: $ref: '#/components/schemas/AlertId' InstitutionId: type: string format: uuid description: institution uuid UserId: type: string format: uuid description: user uuid AlertId: type: string format: uuid description: alert uuid AlertType: type: string description: unique alert type name example: user.email.changed Channels: type: object required: - email - push - sms properties: email: type: boolean push: type: boolean sms: type: boolean