OverviewPlatformsAPI Reference
Alerts

Create a channel

POST
/v1/channels

Authorization

AuthorizationBearer <token>

API key minted via POST /v1/api-keys (format mk_live_...)

In: header

Request Body

kindstring
Value in"slack"
channelIdstring

A Slack channel id from the connected workspace.

Length1 <= length <= 40
channelNamestring

The channel name, for the label.

Length1 <= length <= 90
events?array<string>

Attention events to receive here, on top of whatever rules send. Omit for none.

Itemsitems <= 6

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.mentio.dev/v1/channels" \  -H "Content-Type: application/json" \  -d '{    "kind": "slack",    "channelId": "string",    "channelName": "string"  }'
{
  "id": "string",
  "label": "string",
  "stats": {
    "alerts": 0,
    "activeAlerts": 0,
    "lastDeliveryAt": "string",
    "last7d": {
      "total": 0,
      "failed": 0
    }
  },
  "createdAt": "string",
  "kind": "slack",
  "config": {
    "channelId": "string",
    "channelName": "string",
    "events": [
      "mention.spike"
    ]
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "retryAfterSeconds": 0
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "retryAfterSeconds": 0
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "retryAfterSeconds": 0
  }
}

Create an alert POST

A rule (what to watch, the filter) times channels. mode instant sends each matching mention as it happens; hourly sends one digest every UTC hour (five minutes past) for the previous full hour, nothing when it had no mention over the rule's floor, to Slack, Telegram and webhook channels only (no schedule); daily sends one digest at schedule.hour in schedule.timezone; weekly sends one a week on schedule.weekday (0 Sunday to 6 Saturday). filter.anyOf adds OR: groups of conditions in the vocabulary of the mentions list, at least one of which must hold on top of the rest of the filter.

Delete an alert DELETE

Next Page