Notifications

List scheduled notifications

Changed on
get/api/v1/deployments/{deploymentId}/notifications

Request

  • Base URL: https://your-tenant.cubecloud.dev
  • URL: https://your-tenant.cubecloud.dev/api/v1/deployments/{deploymentId}/notifications
  • Auth: HTTP bearer

Path parameters

deploymentIdinteger required

Numeric id of the deployment that owns the notification.

Query parameters

dashboardIdinteger nullable

Optional filter: only return notifications for this numeric dashboard id. Provide this OR dashboardPublicId, not both.

dashboardPublicIdstring nullable

Optional filter: only return notifications for this dashboard public id. Provide this OR dashboardId, not both.

recipientUserIdinteger nullable

Optional filter: only return notifications received by this user, by user id. Mutually exclusive with recipientEmail and the embed-user filter.

recipientEmailstring nullable

Optional filter: only return notifications received by this user, by email. Mutually exclusive with recipientUserId and the embed-user filter.

recipientEmbedTenantNamestring nullable

Optional filter: only return notifications received by this embed user. Required together with recipientExternalId; mutually exclusive with the user filters.

recipientExternalIdstring nullable

Optional filter: only return notifications received by this embed user. Required together with recipientEmbedTenantName; mutually exclusive with the user filters.

afterstring
firstinteger

Response

Changes

  • adc4919489f4Revision changes
    • warning

      added the new in_month enum value to the ///////// response property for the response status

    • warning

      added the new in_quarter enum value to the ///////// response property for the response status

    • warning

      added the new in_year enum value to the ///////// response property for the response status

    • warning

      added the new not_in_month enum value to the ///////// response property for the response status

    • warning

      added the new not_in_quarter enum value to the ///////// response property for the response status

    • warning

      added the new not_in_year enum value to the ///////// response property for the response status

  • 55767d7868dfRevision changes
    • info

      added the optional property // to the response with the status