List notification channels¶

List the current user’s in-app, email, and webhook channel settings.

GET https://billing.moi.matrixorigin.cn/api/v1/taas/notification-channels

Before you begin¶

Prepare a personal access token. For creation and management, see Manage personal access tokens.

Results are scoped to data accessible to the current user.

Request example¶

Replace $MOI_PERSONAL_ACCESS_TOKEN in the example with your personal access token.

curl --get "https://billing.moi.matrixorigin.cn/api/v1/taas/notification-channels" \
  -H "X-API-Key: $MOI_PERSONAL_ACCESS_TOKEN"

Successful response¶

Returns HTTP 200 with notification channel settings for the current user.

Response example

{
  "items": [
    {
      "id": "channel_example",
      "user_id": "user_example",
      "channel_key": "in_app",
      "type": "in_app",
      "name": "In-app",
      "enabled": true,
      "readonly": true,
      "priorities": [
        "severe",
        "important",
        "normal"
      ],
      "config_version": 1,
      "created_at": 1788710400,
      "updated_at": 1788710400
    }
  ]
}

Fields

Field	Type	Description
`items`	array of object	Notification channels.
`items[].id`	string	Channel ID.
`items[].user_id`	string	Owning user ID.
`items[].channel_key`	string	Built-in channel key, when present.
`items[].type`	string	Channel type.
`items[].subtype`	string	Webhook subtype, when present.
`items[].name`	string	Channel name.
`items[].enabled`	boolean	Whether enabled.
`items[].readonly`	boolean	Whether the channel is read-only.
`items[].priorities`	array of string	Notification priorities delivered through this channel.
`items[].target_display`	string	Destination; email channels return the saved email address, when present.
`items[].config_version`	integer	Channel configuration version.
`items[].created_at`	integer	Creation time, Unix seconds.
`items[].updated_at`	integer	Update time, Unix seconds.

In field paths, [] denotes each array item.

Last updated on Sep 15, 2026