Sha256: 4cb877902c690f969de5ea23f4c1fa296808e314b4250fccd94ceb4eca910310

Contents?: true

Size: 1.01 KB

Versions: 2

Compression:

Stored size: 1.01 KB

Contents

# Examples

These example files demonstrate worked examples of how to use the gem.  
They are written in a way that you can:
- send the messages to your own Slack workspace, when a valid Slack `webhook_url` has been provided (see `./config.rb`)
- copy and paste the output to Slack's [Block Builder Kit](https://app.slack.com/block-kit-builder) to validate the output without having to send a message to Slack

> [!NOTE]
> There are some values that need to be valid otherwise Slack, or the Block Builder Kit UI, will return a warning reporting the block output is invalid

## How to use
1. Update `./config.rb`
1. Run `bundle exec examples/simple_example.rb`

> [!TIP]
> When using [Block Builder Kit](https://app.slack.com/block-kit-builder) to validate the output, set `SUPPRESS_WEBHOOK_MESSAGE=true` to suppress lines that would invalid the output, e.g.:
> `SUPPRESS_WEBHOOK_MESSAGE=true examples/simple_example.rb | pbcopy` # on Mac
> `SUPPRESS_WEBHOOK_MESSAGE=true examples/simple_example.rb | xclip -selection clipboard` # on Linux

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
slack-ruby-block-kit-0.25.0 examples/README.md
slack-ruby-block-kit-0.24.0 examples/README.md