nestjs-slack

Lightweight library to use Slack in NestJS applications.

Quick Start Guide · Request Feature · Report Bug

NestjS Slack helps you sending Slack messages in your NestJS application. Combined with slack-block-builder you can easily create maintainable, testable and reusable Slack code declaratively and ready for production.

This documentation is for v2 of this library. If you are looking for v1 documentation, please check the v1 branch.

:zap:   Features

• Used in many production workloads.
• Building blocks with slack-block-builder.
• Supports sending messages directly to Slack Web API.
• Supports Slack webhooks.
• Supports Google Logging.

:space_invader:   Usage

▶ yarn add nestjs-slack

import { Module } from '@nestjs/common';
import { SlackModule } from 'nestjs-slack';

@Module({
  imports: [
    SlackModule.forRoot({
      type: 'api',
      token: '<insert-token-here>',
    }),
  ],
})
export class AppModule {}

To use webhook type, you'll typically use these settings:

SlackModule.forRoot({
  type: 'webhook',
  url: '<the webhook url>',
}),

You can also add multiple webhooks, like this:

SlackModule.forRoot({
  type: 'webhook',
  channels: [
    {
      name: 'dev',
      url: '<a webhook url>',
    },
    {
      name: 'customers',
      url: '<a webhook url>',
    },
  ],
}),

You can also get type assertions if you add a Typescript definition like this:

declare module 'nestjs-slack' {
  type Channels = 'dev' | 'customers';
}

Example

You can easily inject SlackService to be used in your services, controllers, etc.

import { Injectable } from '@nestjs/common';
import { SlackService } from 'nestjs-slack';

@Injectable()
export class AuthService {
  constructor(private service: SlackService) {}

  helloWorldMethod() {
    this.service.sendText('Hello world was sent!');
    return 'hello world';
  }
}

The underlying Slack WebClient is also available to use on the SlackService:

import { Injectable } from '@nestjs/common';
import { SlackService } from 'nestjs-slack';

@Injectable()
export class AuthService {
  constructor(private service: SlackService) {}

  otherSlackWebClientMethod(email) {
    return await this.service.client.users.lookupByEmail(email);
  }
}

Use with Google Logging

▶ yarn add @google-cloud/logging

import { SlackModule } from 'nestjs-slack';

@Module({
  imports: [SlackModule.forRoot({ type: 'google' })],
})
export class AppModule {}

When type is set to google the @google-cloud/logging package will be used to send logs to stdout according to structured logs.

You can deploy gcl-slack to consume logs from this library.

Contribute & Disclaimer

We love to get help 🙏 Read more about how to get started in CONTRIBUTING 🌳