Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: change the slack channel instructions #2478

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: change the slack channel instructions #2478

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions website/docs/r/notification_channel.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,10 @@ Each notification channel type supports a specific set of arguments for the `pro
* `email` - (Required) Specifies the user email for integrating with Pagerduty.
* `customDetails` - (Optional) Free text that *replaces* the content of the alert.
* `SLACK`
* `channelId` - (Required) Specifies the Slack channel id. This can be found in slack browser via the url. Example - https://app.slack.com/client/\<UserId>/\<ChannelId>.
* `customDetailsSlack` - (Optional) A map of key/value pairs that represents the slack custom details. Must be compatible with Slack's blocks api.
* `channelId` - (Optional) Specifies the Slack channel id. This can be found in slack browser via the url. Example - https://app.slack.com/client/\<UserId>/\<ChannelId>.
* `channelName` - (Optional) Specifies the Slack channel name.
* `customDetailsSlack` - (Optional) A map of key/value pairs that represents the slack custom details. Must be compatible with Slack's blocks api. \
Copy link
Contributor

@Nandu-pns Nandu-pns Oct 6, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @nzur-newrelic - Was just reviewing this in doc preview, maybe better to use "<br>" instead of "\" at the end of line ?

**Note**: The `SLACK` properties must include either channelId or channelName (not both).

## Attributes Reference

Expand Down