Obtaining Webhook Information

Function

This API is used to obtain webhook information.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/api/pipelines/{pipeline_id}/webhook

**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

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
pipelineId	String	Pipeline ID.
projectId	String	Project ID.
region	String	Region.
status	Boolean	Webhook status.
useIam	Boolean	Whether to use IAM.
webhookUrl	String	Webhook address.

Example Requests

GET https://{endpoint}/v5/0b015e21d3054a3fb03839c43b7cd034/pipelines/12780316f8ca4d8c86bee1bcf24691be/webhook

Example Responses

Status code: 200

{
  "pipelineId" : "36dd030a69324d489e4241db387acbdf",
  "projectId" : "4fd6dac138aa4d4d965140a19b26a810",
  "region" : "string",
  "status" : true,
  "useIam" : false,
  "webhookUrl" : "https://wxample.com/v5/4fd6dac138aa4d4d965140a19b26a810/pipelines/36dd030a69324d489e4241db387acbdf/webhook/callback-run/cn-north-7?access_token=c60d5a520b2a42a1afb1c07ec0666e49"
}