Skip to content

Create



POST /api/v1/notify_object/create

Overview

Create a notification target

Body Request Parameters

Parameter Name Type Required Description
type string Y Trigger rule type, default is trigger
Allow empty: True
Allowed values: ['dingTalkRobot', 'HTTPRequest', 'wechatRobot', 'mailGroup', 'feishuRobot', 'sms', 'simpleHTTPRequest', 'slackIncomingWebhook', 'teamsWorkflowWebhook']
name string Y Notification target name
Allow empty: False
optSet json Alert settings
Allow empty: False
openPermissionSet boolean Enable custom permission configuration, (default false: not enabled), when enabled, the operation permissions of this rule are based on permissionSet
Allow empty: False
permissionSet array Operation permission configuration, can configure (roles (except owner), member UUID, team UUID)
Example: ['wsAdmin', 'acnt_xxxx', 'group_yyyy']
Allow empty: False

Parameter Additional Notes

Data Description.

**Request Parameter Description: ** | Parameter Name | type | Description | | ---------------- | ---- | ---------------------------------------------------- | | name | string | Notification target name | | type | string | Trigger rule type | | optSet | dict | Alert settings | | openPermissionSet | boolean | Whether to enable custom permission configuration, default false | | permissionSet | array | Operation permission configuration |

**1. type=dingTalkRobot optSet parameters **

key Type Required Description
webhook String Required DingTalk robot call address
secret String Required DingTalk robot call secret (add robot - security settings - signature)

**2. type=HTTPRequest optSet parameters **

key Type Required Description
url String Required HTTP call address

**3. type=wechatRobot optSet parameters **

key Type Required Description
webhook String Required Robot call address

**4. type=mailGroup optSet parameters **

key Type Required Description
to Array Required Member account list

**5. type=feishuRobot optSet parameters **

key Type Required Description
webhook String Required Lark robot call address
secret String Required Lark robot call secret (add robot - security settings - signature)

**6. type=sms optSet parameters **

key Type Required Description
to Array Required Phone number list

**7. type=simpleHTTPRequest optSet parameters **

key Type Required Description
url String Required HTTP call address

8. type=slackIncomingWebhook optSet parameters (2025-03-26 iteration added)

key Type Required Description
webhook String Required Robot call address

9. type=teamsWorkflowWebhook optSet parameters (2025-03-26 iteration added)

key Type Required Description
webhook String Required Robot call address

**permissionSet, openPermissionSet field description (2024-06-26 iteration added fields): ** When the notification target configuration openPermissionSet is enabled, only the workspace owner and the roles, teams, members configured in permissionSet can edit/delete When the notification target configuration openPermissionSet is disabled (default), the delete/edit permissions follow the original interface edit/delete permissions

permissionSet field can configure, role UUID(wsAdmin,general, readOnly, role_xxxxx ), team UUID(group_yyyy), member UUID(acnt_xxx) permissionSet field example:

  ["wsAdmin", "general", "group_yyyy", "acnt_xxxx"]

Response


Feedback

Is this page helpful? ×