Browse Docs

Quickstart

    1. Create a Workspace

      Sign up at apialerts.com or download the mobile app (Android, iOS). Create a workspace to organize your notifications.

    2. Get Your API Key

      Navigate to your workspace settings and generate an API key. This key authenticates all your requests.

    3. Send Your First Event

      curl -X POST https://api.apialerts.com/event \
        -H "Authorization: Bearer YOUR-API-KEY" \
        -H "Content-Type: application/json" \
        -d '{ "message": "Hello from API Alerts!" }'
      npm install apialerts-js
      import { ApiAlerts } from 'apialerts-js';
      
      const client = new ApiAlerts('YOUR-API-KEY');
      await client.send({ message: 'Hello from API Alerts!' });
      pip install apialerts-python
      from apialerts import ApiAlerts
      
      client = ApiAlerts('YOUR-API-KEY')
      client.send(message='Hello from API Alerts!')
      go get github.com/apialerts/apialerts-go
      import "github.com/apialerts/apialerts-go"
      
      client := apialerts.New("YOUR-API-KEY")
      client.Send(apialerts.Event{Message: "Hello from API Alerts!"})
    4. Receive Notifications

      You’ll receive a push notification on all devices connected to your workspace. Open the mobile app to see your event in the feed.

What’s Next?

  • Explore SDKs — See all available SDKs and their full documentation
  • API Reference — Learn about the REST API and all available options