Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ WebHook/ Obtaining the Details of Specified Logs of Specified Webhooks in Projects
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Obtaining the Details of Specified Logs of Specified Webhooks in Projects

Function

This API is used to obtain the details of specified logs of specified Webhooks in projects.

Debugging

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

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsrepo::getProjectSetting

Read

-

codeartsrepo:ProjectId

-

-

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

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

Range

String length: 32 characters.

hook_id

Yes

Integer

Definition

Webhook ID.

Value range:

1~2147483647

log_id

Yes

Integer

Definition:

Webhook log ID.

Value range:

1~2147483647

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

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

Constraints

N/A

Range

1–100,000 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

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.

request_headers

Object

Definition:

Request header. Sensitive information, such as the transferred token, will be hidden here.

request_data

Object

Definition:

Request body. The email address will be hidden here.

response_headers

Object

Definition:

Response header.

response_body

Object

Definition:

Response body.

Status code: 401

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 5 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/1

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",
  "request_headers" : {
    "Content-Type" : "application/json"
  },
  "request_data" : {
    "object_kind" : "push"
  },
  "response_headers" : {
    "Content-Length" : 0
  },
  "response_body" : "{\"result\": \"success\"}"
}

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