#slack #client #api-bindings #web-api #sockets

slack-morphism

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

93 releases (31 stable)

2.1.0 Mar 4, 2024
1.17.0 Jan 14, 2024
1.16.1 Dec 14, 2023
1.15.1 Oct 25, 2023
0.3.1 Oct 20, 2020

#2 in #slack

Download history 1706/week @ 2023-12-21 1883/week @ 2023-12-28 3034/week @ 2024-01-04 2801/week @ 2024-01-11 3066/week @ 2024-01-18 3755/week @ 2024-01-25 3190/week @ 2024-02-01 3070/week @ 2024-02-08 2968/week @ 2024-02-15 3364/week @ 2024-02-22 4047/week @ 2024-02-29 3336/week @ 2024-03-07 4464/week @ 2024-03-14 4158/week @ 2024-03-21 3518/week @ 2024-03-28 3049/week @ 2024-04-04

15,907 downloads per month
Used in 8 crates (3 directly)

Apache-2.0

380KB
9K SLoC

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

Dependencies

~8–23MB
~355K SLoC