Skip to content
Browse documentation

OpenAPI operations

Save an event as a bookmark

POST
/v1/bookmarks
curl --request POST \
  --url https://api.hooks.events/v1/bookmarks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "eventId": "example", "name": "example" }'

Requires the endpoints:write scope.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
eventId
required
string
>= 1 characters
name
required
string
>= 1 characters <= 120 characters

Example generated

{
  "eventId": "example",
  "name": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Success

Media typeapplication/json
object
data
required
object
id
required

Resource id

string
projectId
required
string
endpointId
required

Endpoint the payload arrived at

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

Saved inbound headers as a JSON string

string
sourceEventId
required

Null once the source event was purged

string | null
createdAt
required

ISO-8601 timestamp

string
updatedAt
required

ISO-8601 timestamp

string
key
additional properties
key
additional properties

Example generated

{
  "data": {
    "id": "example",
    "projectId": "example",
    "endpointId": "example",
    "name": "example",
    "eventType": "example",
    "method": "example",
    "payloadRef": "example",
    "payloadSize": 1,
    "payloadHash": "example",
    "headersJson": "example",
    "sourceEventId": "example",
    "createdAt": "example",
    "updatedAt": "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
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "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
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "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
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "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
key
additional properties

Example generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "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