Publish API

curl -X POST https://alrim.io/<publishKey> \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Smoke test",
    "body": "publish key in path"
  }'

curl -X POST https://alrim.io/<publishKeyA>,<publishKeyB> \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Server deploy",
    "body": "send the same payload to two channels"
  }'

curl -X POST https://alrim.io/api/notify \
  -H 'X-Alrim-Key: <publishKeyA>,<publishKeyB>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Server deploy",
    "body": "send the same payload to two channels"
  }'

curl -X POST https://alrim.io/<publishKey> \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Smoke test",
    "body": "publish key in path"
  }'

curl -X POST https://alrim.io/<publishKey>   -H 'X-Alrim-Severity: warning'   -H 'X-Alrim-Level: 2'   -F 'title=Incident report'   -F 'body=Screenshots and runbook attached'   -F 'data={"service":"incident-api"}'   -F 'files=@./screenshot.png'   -F 'files=@./runbook.pdf'

curl -X POST https://alrim.io/ \
  -H 'Content-Type: application/json' \
  --data-binary '{"title":"Server deploy","body":"v1.2.3 shipped"}'

curl https://alrim.io/

{
  "ok": true,
  "channel_code": "3ba3f5f43b92602683c19aee62a20342",
  "channel_url": "https://alrim.me/3ba3f5f43b92602683c19aee62a20342",
  "notification_id": "d6d5f95b3bbd4fb4b8d98f7bc8e89c17",
  "created_at_ms": 1712345678901,
  "attachments": []
}

{
  "ok": true,
  "total": 2,
  "sent": 2,
  "failed": 0,
  "results": [
    {
      "index": 0,
      "ok": true,
      "status": 200,
      "body": {
        "ok": true,
        "channel_code": "3ba3f5f43b92602683c19aee62a20342",
        "channel_url": "https://alrim.me/3ba3f5f43b92602683c19aee62a20342",
        "notification_id": "d6d5f95b3bbd4fb4b8d98f7bc8e89c17",
        "created_at_ms": 1712345678901,
        "attachments": []
      }
    },
    {
      "index": 1,
      "ok": true,
      "status": 200,
      "body": {
        "ok": true,
        "channel_code": "e704fc0d4f7f8f0f4ff3f2ea1a9ee5c8",
        "channel_url": "https://alrim.me/e704fc0d4f7f8f0f4ff3f2ea1a9ee5c8",
        "notification_id": "afd6728f7be84082922553cc4ca1363b",
        "created_at_ms": 1712345678901,
        "attachments": []
      }
    }
  ]
}

{
  "ok": false,
  "error": "publishKey must use only lowercase letters (a-z) and digits (0-9). See https://alrim.io/doc for publishKey rules and examples."
}

{
  "ok": true,
  "publish_key": "5765aff90d6e4d2e169b3b496c418cc9",
  "publish_url": "https://alrim.io/5765aff90d6e4d2e169b3b496c418cc9",
  "channel_code": "3ba3f5f43b92602683c19aee62a20342",
  "channel_url": "https://alrim.me/3ba3f5f43b92602683c19aee62a20342",
  "short_code": "123-456",
  "short_code_expires_at_ms": 1712346578901,
  "short_code_notice": "Short code valid for 15 minutes.",
  "notification_id": "d6d5f95b3bbd4fb4b8d98f7bc8e89c17",
  "created_at_ms": 1712345678901,
  "curl": "curl -X POST "https://alrim.io/5765aff90d6e4d2e169b3b496c418cc9" ..."
}

{
  "ok": true,
  "publish_key": "5765aff90d6e4d2e169b3b496c418cc9",
  "publish_url": "https://alrim.io/5765aff90d6e4d2e169b3b496c418cc9",
  "channel_code": "3ba3f5f43b92602683c19aee62a20342",
  "channel_url": "https://alrim.me/3ba3f5f43b92602683c19aee62a20342",
  "short_code": "123-456",
  "short_code_expires_at_ms": 1712346578901,
  "short_code_notice": "Short code valid for 15 minutes.",
  "curl": "curl -X POST "https://alrim.io/5765aff90d6e4d2e169b3b496c418cc9" ...",
  "curl_json": "curl -X POST "https://alrim.io/5765aff90d6e4d2e169b3b496c418cc9" ...",
  "curl_form": "curl -X POST "https://alrim.io/5765aff90d6e4d2e169b3b496c418cc9" ...",
  "curl_text": "curl -X POST "https://alrim.io/5765aff90d6e4d2e169b3b496c418cc9" ..."
}

import { createAlrimPublisher } from '@alrim-me/sdk/server';

const alrim = createAlrimPublisher({
  secret: process.env.ALRIM_SECRET!
});
const deploys = alrim.channel('deploys');

export async function POST() {
  await deploys.publish(
    {
      title: 'Server deploy',
      body: 'v1.2.3 shipped',
      data: { service: 'api' }
    },
    {
      controls: { severity: 'warning', ring: 'force', level: 2 }
    }
  );

  return Response.json({
    subscribe: deploys.subscribeConfig({
      title: 'Deploys'
    })
  });
}

const releaseChannels = alrim.channel(['deploys', 'incidents']);

await releaseChannels.publish({
  title: 'Server deploy',
  body: 'v1.2.3 shipped'
});

// The SDK derives one publish key per channel name and sends:
// POST /api/notify
// X-Alrim-Key: <deploysKey>,<incidentsKey>
// Body remains the notification payload only.
// Fan-out channels are publish-only; use alrim.channel('name') for subscribe config.

import { createAlrimChannel } from '@alrim-me/sdk/server';

const alerts = createAlrimChannel({
  publishKey: process.env.ALRIM_PUBLISH_KEY!
});

await alerts.publish({
  title: 'Direct publish',
  body: 'Using an existing publish key'
});

const fanout = createAlrimChannel({
  publishKey: [process.env.ALERTS_KEY!, process.env.INCIDENTS_KEY!]
});

await fanout.publish({ title: 'Fan-out', body: 'Sent to two publish keys' });

await alrim.channel('incidents').publish(
  {
    title: 'Incident report',
    body: 'Screenshots and runbook attached',
    data: { incidentId: 'inc_123' }
  },
  {
    attachments: [
      chartFile,
      { name: 'runbook.txt', content: 'restart api workers', type: 'text/plain' },
      { name: 'payload.json', content: JSON.stringify({ incidentId: 'inc_123' }), type: 'application/json' }
    ]
  }
);

// Attachments switch the request to multipart/form-data.
// Pass File/Blob objects directly, or { name, content, type } on the server.
// The JSON payload is sent in the data field; files are repeated files fields.

import { AlrimPublishError } from '@alrim-me/sdk/server';

try {
  await alrim.channel('deploys').publish({ title: 'Ping' });
} catch (error) {
  if (error instanceof AlrimPublishError) {
    console.error(error.status, error.body);
  }
}

import { createAlrimPublisher } from '@alrim-me/sdk/server';

const alrim = createAlrimPublisher({
  secret: process.env.ALRIM_SECRET!
});
const deploys = alrim.channel('deploys');

export const load = () => ({
  subscribe: deploys.subscribeConfig({
    title: 'Deploys'
  })
});

import { createAlrimPublisher } from '@alrim-me/sdk/server';

const alrim = createAlrimPublisher({
  secret: process.env.ALRIM_SECRET!
});

export default defineEventHandler(async () => {
  const deploys = alrim.channel('deploys');

  await deploys.publish({
    title: 'Server deploy'
  });

  return {
    subscribe: deploys.subscribeConfig({
      title: 'Deploys'
    })
  };
});

import express from 'express';
import { createAlrimPublisher } from '@alrim-me/sdk/server';

const app = express();
const alrim = createAlrimPublisher({
  secret: process.env.ALRIM_SECRET!
});
const deploys = alrim.channel('deploys');

app.post('/deploy', express.json(), async (_req, res) => {
  await deploys.publish({ title: 'Server deploy' });
  res.json({ ok: true });
});

app.get('/subscribe-config', (_req, res) => {
  res.json(deploys.subscribeConfig({
    title: 'Deploys'
  }));
});

<script src="https://alrim.me/sdk/v1/alrim-subscribe.js"></script>

<alrim-me
  channel-code="3ba3f5f43b92602683c19aee62a20342"
  title="Deploys"
  origin="https://alrim.me"
></alrim-me>