Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ WebHook/ Obtaining the Log Lists of Specified Webhooks in Projects
Updated on 2026-04-28 GMT+08:00
View PDF

Obtaining the Log Lists of Specified Webhooks in Projects

Function

This API is used to obtain the log lists of specified Webhooks in repository groups.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET https://{hostURL}/v4/projects/{project_id}/hooks/{hook_id}/logs

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

You can obtain the unique project identifier, 32-character UUID, by calling the API used to query the project list.

Value range:

32 characters

hook_id

Yes

Integer

Definition

Webhook ID.

Value range:

1~2147483647
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition

Offset, which starts from 0.

Value range:

0~2147483647

Default value:

0

limit

No

Integer

Definition

Number of returned records.

Value range:

1~100

Default value:

20

repository_id

No

Integer

Definition:

Repository ID.

Value range:

1~2147483647

uuid

No

String

Definition:

Each time the Webhook sends a message, the request body contains the uuid field. UUIDs are unique. The UUID in the Webhook event related to a merge request will include the merge request IID. You can use the complete UUID or merge request IID.

Constraints:

Optional.

Value range:

1 to 100 characters.

Default value:

N/A.

created_after

No

String

Definition:

Start time of the search execution period.

created_before

No

String

Definition:

End time of the search execution period.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

Constraints

Mandatory.

Range

1–100,000 characters.

Default Value

N/A.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-Total

String

Definition:

Total number of results of the current request.
Table 5 Response body parameters

Parameter

Type

Description

[items]

Array of WebhookLogExtendDto objects

Definition:

Webhook execution log data, including the repository information.
Table 6 WebhookLogExtendDto

Parameter

Type

Description

id

Integer

Definition:

Webhook log ID.

Value range:

1~2147483647

web_hook_id

Integer

Definition:

Webhook ID.

Value range:

1~2147483647

trigger

String

Definition:

Trigger type.

url

String

Definition:

Request address.

response_status

String

Definition:

Response status. The default value is the response code. If the Webhook address does not return a response or other exceptions occur, internal error is recorded.

execution_duration

Double

Definition:

Response duration, in seconds.

Value range:

0~300

uuid

String

Definition:

Each time the Webhook sends a message, the request body contains the uuid field. The value here is the uuid field of the record.

created_at

String

Definition:

Creation time.

updated_at

String

Definition:

Update time.

repository

WebhookRepositoryDto object

Definition:

Basic information about the repositories associated with the Webhook execution logs.
Table 7 WebhookRepositoryDto

Parameter

Type

Description

id

Integer

Definition:

Repository ID.

Value range:

1~2147483647

namespace

String

Definition:

Repository path.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

GET https://{endpoint}/v4/projects/a642c851d4dc4853b595e5c8a5e56df7/hooks/1/logs

Example Responses

Status code: 200

OK

[ {
  "id" : 664135687,
  "web_hook_id" : 990085,
  "trigger" : "push_hooks",
  "url" : "http://demo.com",
  "response_status" : "200",
  "execution_duration" : 0.01,
  "created_at" : "2025-05-23T14:54:37.780+08:00",
  "updated_at" : "2025-05-23T14:54:37.780+08:00",
  "uuid" : "161f36e5-fe6c-428d-9c17-1ce833f810e6",
  "repository" : {
    "id" : 1,
    "namespace" : "group/hello"
  }
} ]

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status code: 403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Bad Request

Error Codes

See Error Codes.

Parent topic: WebHook