Docs
Quick Start

Quick Start

Setup your Project

Loggl uses projects to give you a workspace for each of your applications. Within a project, you may create as many channels to organize your events in any way you choose.

To get started, create your first project and channel. In this example, I have called my project my-website and my first channel user-register

The project and channel values should be lowercase! Alphabet characters, digits, and dashes "-" are accepted. Validation Regex: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Copy your API token

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error. Head to the API Keys page under Settings, then create and copy a new API Key.

Publish your first event

Now you can publish your first event to Loggl. To do so, make a POST request to the log endpoint. Once you have published your event, it will show up in the Loggl App in real-time, and you will receive a push notification if you have set the notify flag to true.

curl --location --request POST 'https://loggl.net/api/v1/log' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "project": "my-website",
    "channel": "user-register",
    "event": "User Registered",
    "description": "email: [email protected]",
    "icon": "🔥",
    "notify": true
}'