Sign in
Hook Run

List hook call logs

⚠️ Deprecated: Use List hook runs instead.

List all the logs from all running hooks with optional filters and pagination.

The logs are sorted by the start timestamp in descending order.

get/api/v1/hooks/logs

Query parameters

request_idstring

Match the specified request_id.

log_levelstring

Match the specified log level (or multiple log levels).

hookinteger

Match given the hook id (or multiple ids).

timestamp_beforestring date-time

Filter for log entries before given timestamp.

timestamp_afterstring date-time

Filter for log entries after given timestamp.

start_beforestring date-time

Filter for log entries before given start timestamp.

start_afterstring date-time

Filter for log entries after given start timestamp.

status'waiting' | 'running' | 'completed' | 'cancelled' | 'failed'

Match the log entry status (or multiple statuses).

status_codeinteger

Match the response status_code (or multiple).

queueinteger[]

Queue ID(s) filter

annotationinteger[]

Annotation ID(s) filter

emailinteger

Match the given email id (or multiple ids).

searchstring

Full text filter across all the log entry fields.

page_sizeinteger

Maximum number of results per page (between 1 and 100, defaults to 100).

Response

OK

Example response

{
  "results": [
    {
      "timestamp": "2023-09-23T12:00:00.000000Z",
      "request_id": "6166deb3-2f89-4fc2-9359-56cc8e3838e4",
      "event": "annotation_content",
      "action": "updated",
      "annotation_id": 1,
      "queue_id": 1,
      "email_id": 1,
      "hook_id": 1,
      "hook_type": "webhook",
      "message": "message",
      "request": "{}",
      "response": "{}",
      "output": "Function execution scheduled",
      "start": "2023-09-23T12:00:00.000000Z",
      "end": "2023-09-23T12:00:00.000000Z",
      "settings": "{}",
      "status": "completed",
      "uuid": "6166deb3-2f89-4fc2-9359-56cc8e3838e4"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.