Skip to content
Browse documentation

OpenAPI operations

List events

GET
/v1/events
curl --request GET \
  --url 'https://api.hooks.events/v1/events?status=delivered' \
  --header 'Authorization: Bearer <token>'

Requires the endpoints:read scope.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
cursor
string

Cursor from a previous nextCursor

limit
integer
>= 1 <= 100

Page size, 1–100 (default 20)

endpointId
string

Only events from this endpoint

status
string
Allowed values: delivered failed filtered duplicate ignored
q
string
<= 200 characters

Free-text match over the inline payload and headers JSON

filter
string
<= 500 characters

Field match, for example body.data.object.id=ch_123 or headers.x-github-event=push

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
data
required
Array<object>
object
id
required

Resource id

string
projectId
required
string
endpointId
required
string
eventType
required
string | null
method
required
string
payloadRef
required
string
payloadSize
required
integer
>= -9007199254740991 <= 9007199254740991
payloadHash
required
string
headersJson
required

Inbound headers as a JSON string

string
normalizedJson
required
string | null
dedupeKey
required
string | null
duplicateOfEventId
required
string | null
filterReason
required
string | null
filterDetail
required
string | null
signatureVerified
required
boolean
receivedAt
required

ISO-8601 timestamp

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 generated

{
  "data": [
    {
      "id": "example",
      "projectId": "example",
      "endpointId": "example",
      "eventType": "example",
      "method": "example",
      "payloadRef": "example",
      "payloadSize": 1,
      "payloadHash": "example",
      "headersJson": "example",
      "normalizedJson": "example",
      "dedupeKey": "example",
      "duplicateOfEventId": "example",
      "filterReason": "example",
      "filterDetail": "example",
      "signatureVerified": true,
      "receivedAt": "example",
      "createdAt": "example"
    }
  ],
  "nextCursor": "example"
}

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