Quick Start

Get started with Alertiqo in under 5 minutes. Choose your platform below.

1. Create an Account

First, create a free account and set up your first project to get an API key.

2. Install the SDK

Choose your platform and install the appropriate SDK:

L Laravel / PHP 

composer require hymns/alertiqo-client-php

Then add to your .env:

ALERTIQO_API_KEY=your-api-key
ALERTIQO_ENDPOINT=https://alertiqo.io

For Laravel 11+, add to bootstrap/app.php:

use Alertiqo\Laravel\Integration;

return Application::configure(basePath: dirname(__DIR__))
    ->withExceptions(function (Exceptions $exceptions) {
        Integration::handles($exceptions);
    })
    ->create();

For Laravel 10 and below, add to app/Exceptions/Handler.php:

use Alertiqo\Laravel\Integration;

public function register(): void
{
    $this->reportable(function (Throwable $e) {
        Integration::captureException($e);
    });
}

JS JavaScript (Browser) 

npm install @hymns/alertiqo

Then initialize in your app:

import Alertiqo from '@hymns/alertiqo';

const alertiqo = new Alertiqo({
  apiKey: 'your-api-key',
  endpoint: 'https://alertiqo.io',
});

alertiqo.init();

N Node.js 

npm install @hymns/alertiqo-node

Then initialize in your app:

const Alertiqo = require('@hymns/alertiqo-node').default;

const alertiqo = new Alertiqo({
  apiKey: 'your-api-key',
  endpoint: 'https://alertiqo.io',
});

alertiqo.init();

Py Python 

pip install alertiqo

Then initialize in your app:

from alertiqo import Alertiqo

alertiqo = Alertiqo(
    api_key="your-api-key",
    endpoint="https://alertiqo.io",
)

alertiqo.init()

Go Go 

go get github.com/hymns/alertiqo-go

Then initialize in your app:

import "github.com/hymns/alertiqo-go"

client := alertiqo.New(alertiqo.Config{
    APIKey:   "your-api-key",
    Endpoint: "https://alertiqo.io",
})

client.Init()

Rb Ruby 

gem install alertiqo

Or add to your Gemfile:

gem 'alertiqo'

Then initialize in your app:

require 'alertiqo'

Alertiqo.configure do |config|
  config.api_key = 'your-api-key'
  config.endpoint = 'https://alertiqo.io'
end

Alertiqo.init

3. Test Your Setup

Trigger a test error to verify everything is working:

Laravel

php artisan alertiqo:test

JavaScript / Node.js

alertiqo.captureMessage('Test error from Alertiqo!');

4. View Your Errors

Head to your dashboard to see captured errors. You can also set up notifications to get alerted via Slack, Email, or Webhooks.

That's it! Your application is now tracking errors. Check out the SDK-specific documentation for advanced features like breadcrumbs, user context, and custom tags.

Next Steps