作成¶
POST /api/v1/notify_object/create
概要¶
通知オブジェクトを作成します。
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| type | string | Y | トリガールールタイプ、デフォルトは trigger空欄可: True 選択可能値: ['dingTalkRobot', 'HTTPRequest', 'wechatRobot', 'mailGroup', 'feishuRobot', 'sms', 'vms', 'simpleHTTPRequest', 'slackIncomingWebhook', 'teamsWorkflowWebhook', 'googleChatWebhook', 'telegramBot'] |
| name | string | Y | 通知オブジェクト名 空欄不可: False |
| optSet | json | アラート設定 空欄不可: False |
|
| openPermissionSet | boolean | カスタム権限設定を有効にする(デフォルト false: 無効)。有効にすると、このルールの操作権限は permissionSet に従います。 空欄不可: False |
|
| permissionSet | array | 操作権限設定。設定可能な値(オーナーを除くロール、メンバー UUID、チーム UUID) 例: ['wsAdmin', 'acnt_xxxx', 'group_yyyy'] 空欄不可: False |
パラメータ補足説明¶
データ説明.
リクエストパラメータ説明: | パラメータ名 | type | 説明 | | ----------------- | ---- | ---------------------------------------------------- | | name | string | 通知オブジェクト名 | | type | string | トリガールールタイプ | | optSet | dict | アラート設定 | | openPermissionSet | boolean | カスタム権限設定を有効にするかどうか(デフォルト false) | | permissionSet | array | 操作権限設定 |
1. type=dingTalkRobot の optSet パラメータ
| key | 型 | 必須 | 説明 |
|---|---|---|---|
| webhook | String | 必須 | DingTalk ボット呼び出し URL |
| secret | String | 必須 | DingTalk ボット呼び出しシークレット(ボット追加 → セキュリティ設定 → 署名) |
2. type=HTTPRequest の場合の optSet パラメータ
| key | 型 | 必須 | 説明 |
|---|---|---|---|
| url | String | 必須 | HTTP 呼び出し URL |
| headersConfig.isOpen | Boolean | 任意 | Header 設定を有効にするかどうか |
| headersConfig.items[].key | String | 任意 | Header Key。先頭・末尾のスペースを除去して検証し、大文字小文字を区別せず重複排除 |
| headersConfig.items[].value | String | 任意 | Header Value |
| headersConfig.items[].isSensitive | Boolean | 任意 | 機密値かどうか。機密値は暗号化して保存 |
| bodyTemplate | String | 任意 | カスタム Body テンプレート。HTTPRequest のみサポート |
3. type=wechatRobot の場合の optSet パラメータ
| key | 型 | 必須 | 説明 |
|---|---|---|---|
| webhook | String | 必須 | ボット呼び出し URL |
4. type=mailGroup の場合の optSet パラメータ
| key | 型 | 必須 | 説明 |
|---|---|---|---|
| to | Array | 必須 | メンバーアカウントリスト |
5. type=feishuRobot の optSet パラメータ
| key | 型 | 必須 | 説明 |
|---|---|---|---|
| webhook | String | 必須 | Lark ボット呼び出し URL |
| secret | String | 必須 | Lark ボット呼び出しシークレット(ボット追加 → セキュリティ設定 → 署名) |
6. type=sms の場合の optSet パラメータ
| key | 型 | 必須 | 説明 |
|---|---|---|---|
| to | Array | 必須 | メンバーアカウント UUID、チーム UUID のリスト |
7. type=simpleHTTPRequest の場合の optSet パラメータ
| key | 型 | 必須 | 説明 |
|---|---|---|---|
| url | String | 必須 | HTTP 呼び出し URL |
| headersConfig.isOpen | Boolean | 任意 | Header 設定を有効にするかどうか |
| headersConfig.items[].key | String | 任意 | Header Key。先頭・末尾のスペースを除去して検証し、大文字小文字を区別せず重複排除 |
| headersConfig.items[].value | String | 任意 | Header Value |
| headersConfig.items[].isSensitive | Boolean | 任意 | 機密値かどうか。機密値は暗号化して保存 |
8. type=slackIncomingWebhook の場合の optSet パラメータ(2025-03-26 リリースで追加)
| key | 型 | 必須 | 説明 |
|---|---|---|---|
| webhook | String | 必須 | ボット呼び出し URL |
9. type=teamsWorkflowWebhook の場合の optSet パラメータ(2025-03-26 リリースで追加)
| key | 型 | 必須 | 説明 |
|---|---|---|---|
| webhook | String | 必須 | ボット呼び出し URL |
10. type=vms(電話)の場合の optSet パラメータ
| key | 型 | 必須 | 説明 |
|---|---|---|---|
| to | Array | 必須 | メンバーアカウント UUID、チーム UUID のリスト |
11. type=googleChatWebhook の場合の optSet パラメータ(2026-01-14 リリースで追加)
| key | 型 | 必須 | 説明 |
|---|---|---|---|
| webhook | String | 必須 | ボット呼び出し URL |
12. type=telegramBot の場合の optSet パラメータ(2026-04-13 リリースで追加)
| key | 型 | 必須 | 説明 |
|---|---|---|---|
| token | String | 必須 | Telegram Bot Token |
| chat_id | String | 必須 | ユーザー / グループ / チャンネル ID |
| message_thread_id | String | 任意 | トピック / スレッド ID |
permissionSet、openPermissionSet フィールドの説明(2024-06-26 リリースで追加):
通知オブジェクトで openPermissionSet を有効にした場合、ワークスペースオーナーと permissionSet に設定されたロール、チーム、メンバーのみが編集・削除できます。 通知オブジェクトで openPermissionSet を無効にした場合(デフォルト)、削除・編集権限は既存のインターフェースの編集・削除権限に従います。
permissionSet フィールドには、ロール UUID(wsAdmin, general, readOnly, role_xxxxx)、チーム UUID(group_yyyy)、メンバー UUID(acnt_xxx)を設定できます。 permissionSet フィールドの例: