Skip to content
Browse documentation

OpenAPI operations

Acknowledge, resolve or ignore an issue

PATCH
/v1/issues/{id}
curl --request PATCH \
--url https://api.hooks.events/v1/issues/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "status": "open" }'

Requires the deliveries:retry scope.

id
required
string
Media typeapplication/json
object
status
required
string
Allowed values: open acknowledged resolved ignored

Success

Media typeapplication/json
object
id
required

Resource id

string
projectId
required
string
endpointId
required
string
destinationId
required
string
signature
required

Failure signature: status:4xx/5xx or timeout/dns/tls/network/transform

string
title
required
string
status
required
string
Allowed values: open acknowledged resolved ignored
count
required

Terminal failures absorbed, including reopened ones

integer
>= -9007199254740991 <= 9007199254740991
firstSeenAt
required

ISO-8601 timestamp

string
lastSeenAt
required

ISO-8601 timestamp

string
lastNotifiedAt
required
Any of:

ISO-8601 timestamp

string
sampleDeliveryId
required
string | null
acknowledgedAt
required
Any of:

ISO-8601 timestamp

string
resolvedAt
required
Any of:

ISO-8601 timestamp

string
ignoredAt
required
Any of:

ISO-8601 timestamp

string
createdAt
required

ISO-8601 timestamp

string
updatedAt
required

ISO-8601 timestamp

string
key
additional properties

Example

{
"status": "open"
}

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"
}
}

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"
}
}

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"
}
}

Resource not found

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"
}
}

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"
}
}
X-RateLimit-Limit
integer

Requests allowed per window

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

Seconds until the window resets