https://github.com/Intevel/directus-logsnag

📢 Easily get notified when something in Directus happens.
https://github.com/Intevel/directus-logsnag

directus directus-extension directus-hooks extension logsnag

Last synced: about 2 months ago
JSON representation

📢 Easily get notified when something in Directus happens.

• Host: GitHub
• URL: https://github.com/Intevel/directus-logsnag
• Owner: Intevel
• License: mit
• Created: 2022-07-07T12:09:19.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2022-07-10T11:17:13.000Z (about 2 years ago)
• Last Synced: 2024-04-10T20:53:52.006Z (6 months ago)
• Topics: directus, directus-extension, directus-hooks, extension, logsnag
• Language: TypeScript
• Homepage:
• Size: 173 KB
• Stars: 23
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-directus - Directus LogSnag - Sending your events from Directus directly to your phone using LogSnag. (Extensions / Community)

README

        
![directus-logsnag](https://github.com/Intevel/directus-logsnag/blob/master/banner.png?raw=true)

# Directus LogSnag

📢  Get notified when something in Directus happens.

## What is LogSnag?

LogSnag is a simple event tracking tool. It helps you keep track what is happening within your projects, creates custom feeds, and notifies you of important events.

Register your application [here](https://logsnag.com/)

## Installation

> If you have any questions or problems, open an discussion on Github.

1. Firstly create a LogSnag account

2. Create your LogSnag project and your channels

3. Get your LogSnag API Token, from the API page under settings. Generate or revoke your API tokens there.

4. Clone this repository, copy the file from `dist` to your directus extensions folder `/extensions/hooks/directus-logsnag/`.

5. Now you can get started with configuring ✨

## Configuration

Your configuration file should be in your directus extensions folder under `/extensions/hooks/directus-logsnag/logsnag.config.json`.

```json

{

	"api_token": "-",

	"events": [

		{ "name": "users.create", "project": "test", "channel": "nuxttest", "event": "New User!", "description": "A new Directus user was created", "icon": "🤑", "notify": true },

		{ "name": "payments.create", "project": "test", "channel": "nuxttest", "event": "New Payment", "description": "We've got a new payment :)", "icon": "💸", "notify": true }

	]

}

```

This is the configuration scheme, please insert your LogSnag API Token in `api_token`. 

Now you can configure your events, `name` is the parameter for the event name in Directus. So `users.create` would be the event in Directus which is called when a new User is created, after the event name, the LogSnag Configuration follows, this is how the message which is sended to LogSnag look like.

## License

Published under MIT - Made with 💜  by Conner Luka Bachmann