Channels

Create a channel

POST/v1/channels

webhook, discord, slack, email: created at once (201). A webhook URL must be https and resolve to public addresses only: private, loopback, link-local, cloud metadata and reserved addresses, local host names and URLs with credentials are refused with 422 url_not_allowed (DNS is checked again at every delivery). The webhook signing secret (webhook_secret) is returned once, in this response only.
telegram, hellome: linked by invitation (202). Open invite.link as an administrator of the group within 10 minutes; poll the URL in Location (GET /v1/channel-invites/{token}) to get the channel id.

Plan checks: channel kinds (403 channel_kind_not_in_plan) and number of channels (403 plan_limit_reached).

Authentication: API key (Authorization: Bearer)
Required scope: write

Safe to retry with the Idempotency-Key header: see Idempotency.

Headers#

Idempotency-Keystring
Makes the POST safe to retry for 24 hours.

1 to 255 characters

Request body#

kindstringrequired
Values webhook discord slack email telegram hellome
namestringnullable
Not accepted for telegram and hellome.

at most 80 characters
rolestring
Not accepted for telegram and hellome.

Values alerts escalation
Default "alerts"
localestring
Values fr en
Default "fr"
urlstring
webhook (https, public host), discord (https://discord.com/api/webhooks/…), slack (https://hooks.slack.com/services/…).
emailsarray of string · email
email only.

1 to 10 items

Responses#

201Channel created.

Response headers

Locationstring
Idempotent-Replayedstring
true when the response is a replay of a previous request with the same Idempotency-Key.

Values true

Object fields

idstring · uuid
kindstring
Values webhook discord slack email telegram hellome
namestringnullable
statestring
Values active disabled
rolestring
Values alerts escalation
targetstringnullable
Masked destination, e.g. https://hooks.example.com/aicscan, a***@example.com.
created_atstring · date-time
disabled_atstring · date-timenullable
disabled_reasonstringnullable
last_success_atstring · date-timenullable
linked_atstring · date-timenullable
webhook_secretstringnullable
Webhook only: HMAC-SHA256 signing secret (whsec_…), shown once. Verify X-Signature over X-Timestamp and the body; reject timestamps older than 5 minutes. null in an idempotent replay.

202Invitation created (Telegram, helloMe).

Response headers

Locationstring
/v1/channel-invites/{token}

Object fields

kindstring
Values telegram hellome
statusstring
Values pending
inviteobject
Object fields
- tokenstring
- linkstring · uri
- expires_atstring · date-time
- expires_in_minutesinteger

4xx · 5xxError.

Standard error format: see Errors.

Request

cURL

curl -X POST "https://aicscan.io/v1/channels" \
  -H "Authorization: Bearer $AICSCAN_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "kind": "webhook",
    "url": "https://hooks.example.com/aicscan",
    "name": "SIEM"
  }'

JavaScript

const res = await fetch('https://aicscan.io/v1/channels', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.AICSCAN_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
    "kind": "webhook",
    "url": "https://hooks.example.com/aicscan",
    "name": "SIEM"
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(data.error.code);
console.log(data);

Python

import os, uuid
import requests

resp = requests.post(
    "https://aicscan.io/v1/channels",
    headers={
        "Authorization": f"Bearer {os.environ['AICSCAN_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "kind": "webhook",
        "url": "https://hooks.example.com/aicscan",
        "name": "SIEM"
    },
    timeout=10,
)
resp.raise_for_status()
print(resp.json())

Response 201

JSON

{
  "id": "0193a1b3-7d21-7c55-8e0a-9f1b2c3d4e5f",
  "kind": "webhook",
  "name": "SIEM",
  "state": "active",
  "role": "alerts",
  "target": "https://hooks.example.com/aicscan",
  "created_at": "2026-11-14T09:12:40.118Z",
  "disabled_at": null,
  "disabled_reason": null,
  "last_success_at": null,
  "linked_at": null,
  "webhook_secret": "whsec_2Jc9kq4mWb7aZrX1pQvT8nLd3sYh6fGe0uRiOyKtM5A"
}

Response 202

JSON

{
  "kind": "telegram",
  "status": "pending",
  "invite": {
    "token": "Kx3p9QvT2mWb7aZr",
    "link": "https://t.me/AicscanBot?startgroup=Kx3p9QvT2mWb7aZr",
    "expires_at": "2026-11-14T09:25:00Z",
    "expires_in_minutes": 10
  }
}