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

Updated on 2025-11-12 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Third-Party Pipeline Notifications

Function

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

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A
pipeline_id	Yes	String	Definition: Pipeline ID. Obtain the ID by calling the API for querying pipelines. pipelines.pipelineId indicates the pipeline ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
[items]	Array of PipelineThirdPartyNoticeResp objects	Definition: Response body of the third-party pipeline notifications. Value range: N/A

**Table 3** PipelineThirdPartyNoticeResp
Parameter	Type	Description
notice_id	String	Definition: Notification ID. Value range: The value consists of 32 characters, including digits and letters.
pipeline_id	String	Definition: Pipeline ID. Value range: The value consists of 32 characters, including digits and letters.
notice_type	String	Definition: Message type. Value range: N/A
notice_status	Boolean	Definition: Message status. Value range: N/A
send_url	String	Definition: Sending URL. Value range: N/A
notice_events	Array of strings	Definition: Event type. Value range: N/A
notice_contents	Array of strings	Definition: Message content. Value range: N/A
notice_users	Array of strings	Definition: User who sends the message. Value range: N/A
secret_info	String	Definition: Key information. Value range: N/A
sort_index	Integer	Definition: Sorting order. Value range: N/A

Example Requests

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

Example Responses

Status code: 200

Response body.

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