通知チャンネル (original) (raw)

• 通知チャンネルの一覧取得
• 通知チャンネルの登録
• 通知チャンネルの削除

通知チャンネルの一覧

GET /api/v0/channels

APIキーに必要な権限

• Read

応答

成功時

{ "channels": [, , ...] }

<channel> は以下のキーを持つオブジェクト

type が "email", "slack" または "webhook" の場合は上記に加えて、以下のように詳細な情報を返します

type が email の場合

type が slack の場合

type が webhook の場合

通知チャンネルの登録

※現在はメール通知とSlack, Webhook の3つに対応しています

POST /api/v0/channels

APIキーに必要な情報

• Read
• Write
• メール通知
• Slack
• Webhook

メール通知

入力(メール通知)

応答(メール通知)

成功時

{ "id": , "type": "email", "name": "My Channel", "emails": ["myaddress@example.com"], "userIds": ["userId"], "events": ["alert"] }

失敗時

Slack

入力(Slack)

以下のキーをもつオブジェクト

応答(Slack)

成功時

{ "id": , "type": "slack", "name": "My Channel", "url": "https://hooks.slack.com/services/TAAAA/BBBB/XXXXX", "mentions": { "ok": "ok message", "warning": "warning message" }, "enabledGraphImage": true, "events": ["alert"] }

失敗時

Webhook

入力(Webhook)

以下のキーをもつオブジェクト

応答(Webhook)

成功時

{ "id": , "type": "webhook", "name": "My Channel", "url": "https://example.com/webhook", "enabledGraphImage": true, "events": ["alert"] }

失敗時

通知チャンネルの削除

チャンネルを削除します

DELETE /api/v0/channels/_<channelId>_

APIキーに必要な情報

• Read
• Write

応答

削除される直前のチャンネルの状態が返されます

成功時

フォーマットはチャンネル一覧APIの<channel>と同じ形式です。

失敗時