Skip to content
Browse documentation

OpenAPI operations

List configuration audit entries

GET
/v1/audit-log
curl --request GET \
  --url https://api.hooks.events/v1/audit-log \
  --header 'Authorization: Bearer <token>'

Newest first. Entries record the actor, action, target and submitted field names; request bodies and secret values are never stored.

Requires the endpoints:read scope.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer
>= 1 <= 200

Page size, 1–200 (default 50)

action
string

Filter by action, e.g. endpoint.create

targetId
string

Filter by resource id

since
string

ISO-8601 lower bound

until
string

ISO-8601 upper bound

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
data
required
Array<object>

Configuration write audit entry

object
id
required
string
projectId
required
string
actorType
required
string
Allowed values: session api_key cli
actorId
required
string | null
action
required

Stable action name, e.g. endpoint.create

string
method
required
string
path
required
string
targetType
required
string | null
targetId
required
string | null
status
required

HTTP status the request returned

integer
>= -9007199254740991 <= 9007199254740991
outcome
required
string
Allowed values: success failure
fields
required

Submitted top-level field names; never values

Array<string>
createdAt
required

ISO-8601 timestamp

string
key
additional properties
nextCursor
required

Pass as ?cursor= to fetch the next page

string | null
key
additional properties

Example 

{
  "data": [
    {
      "actorType": "session",
      "outcome": "success"
    }
  ]
}

400

Section titled “400”

Validation error

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required
string
requestId
required

Request id, also echoed in x-request-id

string
issues

Per-field validation details for VALIDATION_ERROR

Array<object>
object
path
required

Body or query field that failed validation

string
message
required
string
key
additional properties
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example",
    "issues": [
      {
        "path": "example",
        "message": "example"
      }
    ]
  }
}

401

Section titled “401”

Missing or invalid credentials

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required
string
requestId
required

Request id, also echoed in x-request-id

string
issues

Per-field validation details for VALIDATION_ERROR

Array<object>
object
path
required

Body or query field that failed validation

string
message
required
string
key
additional properties
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example",
    "issues": [
      {
        "path": "example",
        "message": "example"
      }
    ]
  }
}

403

Section titled “403”

The credential lacks the required scope, or the workspace is not writable

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required
string
requestId
required

Request id, also echoed in x-request-id

string
issues

Per-field validation details for VALIDATION_ERROR

Array<object>
object
path
required

Body or query field that failed validation

string
message
required
string
key
additional properties
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example",
    "issues": [
      {
        "path": "example",
        "message": "example"
      }
    ]
  }
}

429

Section titled “429”

Rate limited

Media typeapplication/json
object
error
required
object
code
required

Machine-readable error code

string
message
required
string
requestId
required

Request id, also echoed in x-request-id

string
issues

Per-field validation details for VALIDATION_ERROR

Array<object>
object
path
required

Body or query field that failed validation

string
message
required
string
key
additional properties
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example",
    "issues": [
      {
        "path": "example",
        "message": "example"
      }
    ]
  }
}

Headers

Section titled “Headers”
X-RateLimit-Limit
integer

Requests allowed per window

X-RateLimit-Remaining
integer
X-RateLimit-Reset
integer

Seconds until the window resets

Retry-After
integer

Seconds to wait before retrying. Absent when the rejection has no retry time (for example the Free lifetime quota).

X-Quota-Limit
integer

Request allowance for the workspace’s plan

X-Quota-Remaining
integer

Requests left in the allowance after this request