Quickstart

Let's get started with Logsh!

Generate an API Key

API tokens help Logsh verify your identity

Click the button "+ Create API Key" and generate your first API key.

Generate a new API Key

Create a Project

Logsh lets you make a project for each app you have. You can make as many as you like!

Click the button "+ Create new project" and give your project a name, like "Logsh"

Create your workspace ( project )

Create a Channel

Channels are like boxes for your events. You could have one for logins, another for payments, and so on.

Click the button "+ Create Channel" and give your channel a name, like "Users"

Create a new channel

---

Send Your First Event

Javascript

await fetch(
    "https://api.logsh.co/api/v1/log", 
    {
        method: "POST",
        headers: { 
            "Content-Type": "application/json",
            "Authorization": "Bearer <API_KEY>"
        },
        body: JSON.stringify({
            project: "logsh",
            icon: "🔥",
            event: "Subscription created",
            channel: "users",
            userId: "[e-mail]",
            description: "New Subscription created",
            notify: false,
            metadata: {
                plan : "premium",
                cycle : "monthly",
                trial : "false",
                mrr : "19.95"
            }
        }),
    }
);

PHP

<?php

    $apiUrl = "https://api.logsh.co/api/v1/log";
    $apiKey = "<API_KEY>";

    $data = [
        "project" => "logsh",
        "icon" => "🔥",
        "event" => "Subscription created",
        "channel" => "users",
        "userId" => "[e-mail]",
        "description" => "New Subscription created",
        "notify" => false,
        "metadata" => [
                "plan" => "premium",
                "cycle" => "monthly",
                "trial" => "false",
                "mrr" => "19.95"
        ]
    ];

    $curl = curl_init();
    curl_setopt_array($curl, [
        CURLOPT_URL => $apiUrl,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => '',
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 0,
        CURLOPT_FOLLOWLOCATION => true,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => 'POST',
        CURLOPT_HTTPHEADER => [
            "Content-Type: application/json",
            "Authorization: Bearer " . $apiKey
        ],
        CURLOPT_POSTFIELDS => json_encode($data)
    ]);

    $response = curl_exec($curl);
    curl_close($curl);

    echo $response;

?>

Python

import requests
import json

url = "https://api.logsh.co/api/v1/log"

payload = json.dumps({
    "project": "logsh",
    "icon": "🔥",
    "event": "Subscription created",
    "channel": "users",
    "userId": "[e-mail]",
    "description": "New Subscription created",
    "notify": False,
    "metadata": {
        "plan" : "premium",
        "cycle" : "monthly",
        "trial" : "false",
        "mrr" : "19.95"
    }
})

headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer <API_KEY>'
}

response = requests.post(url, headers=headers, data=payload)

cURL

curl --location --request POST 'https://api.logsh.co/api/v1/log' \
--header 'Authorization: Bearer <API_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "project": "logsh",
    "icon": "🔥",
    "event": "Subscription created",
    "channel": "users",
    "userId": "[e-mail]",
    "description": "New Subscription created",
    "notify": False,
    "metadata": {
        "plan" : "premium",
        "cycle" : "monthly",
        "trial" : "false",
        "mrr" : "19.95"
    }
}'

Publish a event in Logsh.co

POST https://api.logsh.co/api/v1/log

Headers

Name	Value	Required
Content-Type *	application/json	yes
Authorization *	Bearer <token>	yes

Body

Name	Type	Description	Required
project *	string	Project Name	yes
channel *	string	Channel Name	yes
event *	string	Event Name	yes
description	string	Event Description	no
userId	string	User Who Realizes The Event	no
icon	emoji	Event Icon	no
notify	boolean	Notify Event	no
metadata	JSON key : string value : string	Custom Fields	no

Response

200

400

{
  "name": "validation_error",
  "message": ""
}

401

{
  "name": "missing_api_key",
  "message": ""
}

403

{
  "name": "invalid_api_Key",
  "message": ""
}

404

{
  "name": "not_found",
  "message": ""
}

429

{
  "name": "rate_limit_exceeded",
  "message": ""
}