Skip to main content
​
id
integer
required

Unique identifier for the request log.

Example:

98231774

​
type
enum<string>
required

request for an API request to Knot. webhook for a webhook delivery attempt to your endpoint. Each webhook retry is a separate log.

Available options:
request,
webhook
Example:

"webhook"

​
datetime
string<date-time>
required

When the request was made, in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).

Example:

"2026-10-15T14:32:08Z"

​
method
string | null
required

HTTP method of the request.

Example:

"POST"

​
path
string | null
required

For request logs, the Knot API path that was called, including its query string. Sensitive query parameter values are masked. null for webhook logs.

Example:

null

​
url
string | null
required

For webhook logs, the endpoint URL Knot sent the webhook to. Query parameter values and credentials are masked. null for request logs.

Example:

"https://example.com/webhooks/knot?token=********"

​
event
string | null
required

For webhook logs, the webhook event. null for request logs.

Example:

"AUTHENTICATED"

​
status_code
integer
required

HTTP status code of the response. For webhook logs, this is the status code your endpoint returned. Knot records 504 when your endpoint times out or can't be reached.

Example:

200

​
latency_ms
integer | null
required

Time taken to respond, in milliseconds.

Example:

184

​
session_id
string | null
required

The session the log belongs to, if any.

Example:

"915efe72-5136-4652-9a1f-d9d48003c102"

​
task_id
integer | null
required

The task the log belongs to, if any.

Example:

7754123

​
external_user_id
string | null
required

Your unique identifier for the user, if any.

Example:

"user-123"

​
request_body
string | null
required

The request body as a string. Card data, credentials, tokens, email addresses, phone numbers, and addresses are replaced by ********. external_user_id, merchant names, and account details are not masked. For request logs, this is the body you sent to Knot. For webhook logs, this is the webhook payload Knot sent to your endpoint.

​
request_body_truncated
boolean
required

true if request_body was cut to 8 KB.

Example:

false

​
response_body
string | null
required

The response body as a string, masked like request_body. For request logs, this is Knot's response. For webhook logs, this is your endpoint's response. Successful Knot responses larger than 5 KB are not stored and appear as response too large.

​
response_body_truncated
boolean
required

true if response_body was cut to 8 KB.

Example:

false