Skip to content

Commit

Permalink
Add missing list notification channels API (#6982)
Browse files Browse the repository at this point in the history
GET /_plugins/_notifications/channels API is missing from the documentation

Signed-off-by: Sokratis Papadopoulos <[email protected]>
  • Loading branch information
spapadop authored Apr 23, 2024
1 parent 3ccdf47 commit 1c0b037
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions _observing-your-data/notifications/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,42 @@ GET /_plugins/_notifications/features
}
```

## List all notification channels

To retrieve a list of all notification channels, send a GET request to the `channels` resource.

#### Example request

```json
GET /_plugins/_notifications/channels
```

#### Example response

```json
{
"start_index" : 0,
"total_hits" : 2,
"total_hit_relation" : "eq",
"channel_list" : [
{
"config_id" : "sample-id",
"name" : "Sample Slack Channel",
"description" : "This is a Slack channel",
"config_type" : "slack",
"is_enabled" : true
},
{
"config_id" : "sample-id2",
"name" : "Test chime channel",
"description" : "A test chime channel",
"config_type" : "chime",
"is_enabled" : true
}
]
}
```

## List all notification configurations

To retrieve a list of all notification configurations, send a GET request to the `configs` resource.
Expand Down

0 comments on commit 1c0b037

Please sign in to comment.