https://github.com/zayniddindev/notlify

API for sending website contact forms to Telegram with ease! 📥
https://github.com/zayniddindev/notlify

form nestjs notification telegram

Last synced: 3 days ago
JSON representation

API for sending website contact forms to Telegram with ease! 📥

• Host: GitHub
• URL: https://github.com/zayniddindev/notlify
• Owner: zayniddindev
• License: mit
• Created: 2024-01-30T05:46:50.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-03-24T05:18:01.000Z (8 months ago)
• Last Synced: 2024-03-24T06:23:59.837Z (8 months ago)
• Topics: form, nestjs, notification, telegram
• Language: TypeScript
• Homepage:
• Size: 85 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Notlify - Telegram notifier service for sending website contact forms to Telegram with ease!

### API that sends requests from the site to the appropriate channel or group via Telegram Bot (without exposing Bot token)

### How to run:

> [!IMPORTANT]

> You need a server and a MySQL database to run Notlify.

```sh

git clone [email protected]:zayniddindev/notlify.git

cd ./notlify

yarn & yarn build

cp .env.example .env

# populate .env with database credentials

yarn start:prod

```

### Usage:

> [!IMPORTANT]

> First ask the backend developer to add the project to the database. The following information must be provided:

```sh

tg_bot_token - Telegram bot token of the project (obtained via BotFather)

* The bot must be added to a group and must be an admin

```

#### Sending request:

[POST] -> /notification

Body :

```json

{

  "uid": "test",

  "message": "test"

}

```

#### Response:

```json

{

  "success": true,

  "data": "Message sent successfully!",

  "error": null

}

```

```json

{

  "success": false,

  "error": "Failure message sending",

  "data": null

}

```

### Getting group ID

If the group is open (public), you enter the username, if it is closed (private), you enter the group ID. To get a private ID, you take the link of any message in the group and get the group ID from inside it, for example, in the link `https://t.me/c/1652046431/184`, `1652046431` is the group ID