https://github.com/slackapi/deno-slack-api

Slack API Client for Deno Run on Slack projects
https://github.com/slackapi/deno-slack-api

Last synced: 25 days ago
JSON representation

Slack API Client for Deno Run on Slack projects

• Host: GitHub
• URL: https://github.com/slackapi/deno-slack-api
• Owner: slackapi
• License: mit
• Created: 2022-03-09T19:06:21.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2025-03-05T17:33:50.000Z (about 1 year ago)
• Last Synced: 2025-04-09T22:13:29.212Z (11 months ago)
• Language: TypeScript
• Homepage: https://api.slack.com/automation
• Size: 223 KB
• Stars: 42
• Watchers: 16
• Forks: 18
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# deno-slack-api

[![codecov](https://codecov.io/gh/slackapi/deno-slack-api/graph/badge.svg?token=QKJCI23P5S)](https://codecov.io/gh/slackapi/deno-slack-api)

Slack API Client for Deno Run on Slack projects

```ts

import { SlackAPI } from "jsr:@slack/api";

const client = SlackAPI(token);

// ...or create a client with options

const client = SlackAPI(token, {

  slackApiUrl: "...",

});

await client.chat.postMessage({

  text: "hello there",

  channel: "...",

});

// respond to a response_url

await client.response("...", payload);

// use apiCall() w/ method name

await client.apiCall("chat.postMessage", {

  text: "hello there",

  channel: "...",

});

```

## Requirements

A recent version of `deno`.

## Versioning

Releases for this repository follow the [SemVer](https://semver.org/) versioning

scheme. The SDK's contract is determined by the top-level exports from

`src/mod.ts` and `src/types.ts`. Exports not included in these files are deemed

internal and any modifications will not be treated as breaking changes. As such,

internal exports should be treated as unstable and used at your own risk.

## Running Tests

If you make changes to this repo, or just want to make sure things are working

as desired, you can run:

    deno task test

To get a full test coverage report, run:

    deno task test:coverage

---

### Getting Help

We welcome contributions from everyone! Please check out our

[Contributor's Guide](https://github.com/slackapi/deno-slack-api/blob/main/.github/CONTRIBUTING.md)

for how to contribute in a helpful and collaborative way.