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	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
pipelineId	String	Definition: Pipeline ID. Value range: The value consists of 32 characters, including digits and letters.
projectId	String	Definition: Project ID. Value range: The value consists of 32 characters, including digits and letters.
region	String	Definition: Region. Value range: N/A
status	Boolean	Definition: Webhook status. Value range: true: enabled. false: disabled.
useIam	Boolean	Definition: Whether to use IAM. Value range: true: IAM is used. false: IAM is not used.
webhookUrl	String	Definition: Webhook address. Value range: N/A

Example Requests

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

Example Responses

Status code: 200

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