System-End/slack-morphism-rust
1
0
Fork 0
mirror of https://github.com/System-End/slack-morphism-rust.git synced 2026-04-20 00:25:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
A modern async client library for Rust, supports Slack Web / Events API/Socket Mode and Block Kit.
790 commits 4 branches 102 tags 3 MiB
Find a file
renovate[bot] b8a02ff221
fix(deps): update rust crate http to 1.1 (#249) 
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-03-04 20:06:21 +01:00
.github/workflows Toolchain updates for pipelines 2023-10-24 23:23:34 +02:00
docs Remove obsolete form encoded upload. Update docs for 2.0. (#238) 2024-01-27 14:57:48 +01:00
examples Remove obsolete form encoded upload. Update docs for 2.0. (#238) 2024-01-27 14:57:48 +01:00
src Configurable Slack URL for testing purposes (#247) 2024-03-01 21:32:21 +01:00
.gitignore vim dir to gitignore 2020-10-17 15:12:59 +02:00
Cargo.toml fix(deps): update rust crate http to 1.1 (#249) 2024-03-04 20:06:21 +01:00
CNAME gh-pages workflow fix 2020-08-22 18:40:30 +03:00
CONTRIBUTING.md Update CONTRIBUTING.md 2022-11-03 10:13:01 +01:00
COPYRIGHT.md Compliance updates 2022-10-15 12:02:04 +02:00
LICENSE Docs/Cargo update 2020-08-09 16:12:47 +03:00
README.md Update README.md 2022-10-08 14:18:40 +02:00
renovate.json Add renovate.json 2020-08-22 15:57:31 +00:00
SECURITY.md Security policy update 2024-01-14 15:16:29 +01:00

README.md

Cargo tests and formatting security audit

Slack Morphism for Rust

Slack Morphism is a modern client library for Slack Web/Events API/Socket Mode and Block Kit.

Documentation

Please follow to the official website: https://slack-rust.abdolence.dev.

Examples

https://github.com/abdolence/slack-morphism-rust/tree/master/examples

The examples require to work the following environment variables (from your Slack bot profile in api.slack.com):

  • SLACK_TEST_TOKEN - for Slack client example
  • SLACK_TEST_APP_TOKEN - for Slack client with Socket Mode example
  • SLACK_CLIENT_ID, SLACK_CLIENT_SECRET, SLACK_BOT_SCOPE, SLACK_REDIRECT_HOST - for OAuth routes for Events API example
  • SLACK_SIGNING_SECRET for all routes for Events API example

To run example use with environment variables:

# SLACK_... cargo run --example <client|events_api_server|axum_events_api_server|socket_mode> --all-features

Routes for this example are available on http://:8080:

  • /auth/install - to begin OAuth installation
  • /auth/callback - a callback endpoint for Slack OAuth profile config
  • /push - for Slack Push Events
  • /interaction - for Slack Interaction Events
  • /command - for Slack Command Events

Testing Events API with ngrok

For development/testing purposes you can use ngrok:

ngrok http 8080

and copy the URL it gives for you to the example parameters for SLACK_REDIRECT_HOST.

Example testing with ngrok:

SLACK_CLIENT_ID=<your-client-id> \
SLACK_CLIENT_SECRET=<your-client-secret> \
SLACK_BOT_SCOPE=app_mentions:read,incoming-webhook \
SLACK_REDIRECT_HOST=https://<your-ngrok-url>.ngrok.io \
SLACK_SIGNING_SECRET=<your-signing-secret> \
cargo run --example events_api_server  --all-features

Licence

Apache Software License (ASL)

Author

Abdulla Abdurakhmanov