Updated on 2026-09-24 GMT+08:00

Triggering a Pipeline with a Webhook

Function

This API is used to trigger a pipeline with a webhook.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{projectId}/pipelines/{pipelineId}/webhook/callback-run/{region}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
region	Yes	String	Definition: Region. Constraints: N/A Value range: N/A Default value: N/A
projectId	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
pipelineId	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 only digits and letters. Default value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
access_token	No	String	Definition: Authentication token. Constraints: N/A Value range: N/A Default value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
pipeline_run_id	String	Definition: Pipeline run ID. Value range: The value consists of 32 characters, including only digits and letters.

Example Requests

POST https://{endpoint}/v5/0b015e21d3054a3fb03839c43b7cd034/pipelines/12780316f8ca4d8c86bee1bcf24691be/webhook/callback-run/cn-north-7?access_token=c60d5a520b2a42a1afb1c07ec0666e49

Example Responses

Status code: 200

{
  "pipeline_run_id" : "aeb40413c5444bdcbbf7a060873af7a7"
}

Status Codes

Status Code	Description
200	OK

Error Codes

See Error Codes.

Parent topic: Pipeline Management