🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
DemoInstallSign in
Socket

nestjs-supabase-webhooks

Package Overview
Dependencies
Maintainers
1
Versions
19
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

nestjs-supabase-webhooks

NestJS module for Supabase Database Webhooks

1.1.2
latest
Source
npm
Version published
Weekly downloads
745
105.23%
Maintainers
1
Weekly downloads
 
Created
Source

Nest.js Supabase Webhooks

This is a simple Nest.js module that allows you to easily integrate Supabase Database Webhooks into your Nest.js application.

Requirements

  • Nest.js 10.x or higher
  • Supabase Database Webhook, setup with HMAC Signature

Installation

npm install --save nestjs-supabase-webhooks

Usage

Import the SupabaseWebhooksModule into your root application module.

// app.module.ts
import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { ConfigModule } from '@nestjs/config';
import { SupabaseModule } from 'nestjs-supabase-webhooks';
import { InvitationsService } from './invitations/invitations.service';

@Module({
  imports: [
    ConfigModule.forRoot(),
    SupabaseModule.forRoot(SupabaseModule, {
      enableEventLogs: true,
      webhookConfig: {
        secret: process.env.SUPABASE_WEBHOOK_SECRET,
        headerName: 'x-supabase-signature', // optional, defaults to 'x-supabase-signature'
      },
    }),
  ],
  controllers: [AppController],
  providers: [InvitationsService],
})
export class AppModule {}

Now you can use the @SupabaseEventHandler decorator to listen for Supabase Database Webhook events in your services.

// invitations/invitations.services.ts

import { Inject, Injectable } from '@nestjs/common';
import {
  SupabaseEventHandler,
  SupabasePayload,
} from 'nestjs-supabase-webhooks';

@Injectable()
export class InvitationsService {
  constructor() {}

  @SupabaseEventHandler({
    type: 'INSERT',
    table: 'invitations',
  })
  async insertInvitation(event: SupabasePayload) {
    // Do something with the event, e.g. send an email
  }
}

Keywords

NestJS

FAQs

Package last updated on 16 Nov 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts