Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Updating Third-Party Pipeline Notifications

Updated on 2025-03-25 GMT+08:00

Online Debugging

CLI Examples

View PDF

Updating Third-Party Pipeline Notifications

Function

This API is used to update third-party pipeline notifications.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/api/pipeline-notices/{pipeline_id}/notice/message

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: CodeArts project ID. Constraints: N/A. Value Range: The value contains 32 characters. Default value: N/A.
pipeline_id	Yes	String	Parameter description: Pipeline ID. Constraints: N/A. Value Range: The value contains 32 characters. Default value: N/A.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
notice_id	Yes	String	Message ID.
notice_type	Yes	String	Message type.
notice_status	Yes	Boolean	Message status.
send_url	Yes	String	URL sent.
secret_info	Yes	String	Key information.
notice_events	Yes	Array of strings	Notification event.
notice_contents	Yes	Array of strings	Notification content.
notice_users	Yes	Array of strings	Notified users.
sort_index	Yes	Integer	Sorting.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
status	String	Status.

Example Requests

POST https://(endpoint)/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipeline-notices/0747d5a7099e45f69dc1d099945909a9/notice/message

{
  "notice_id" : "dd58644df44d426d862eea6f8a456b43",
  "notice_type" : "feishu",
  "notice_status" : true,
  "send_url" : "https://123",
  "secret_info" : "121",
  "notice_events" : [ "pipelineRun.pause" ],
  "notice_contents" : [ "projectName" ],
  "notice_users" : [ "12" ],
  "sort_index" : 0
}