Read one destination

GET

/v1/destinations/{id}

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

• Production

Requires the endpoints:read scope.

Authorizations

• apiKey
• sessionCookie

Parameters

Path Parameters

id

required

string

Responses

200

Success

Media typeapplication/json

object

id

required

Resource id

string

endpointId

required

string

name

required

string | null

type

required

Target adapter id; http is the generic webhook

string

url

required

string

status

required

string

Allowed values: active paused

consecutiveFailures

required

integer

>= -9007199254740991 <= 9007199254740991

pauseReason

required

string | null

method

required

string

bodyMode

required

string

delaySeconds

required

Any of:

integer

integer

>= -9007199254740991 <= 9007199254740991

null

null

rateLimitPerMinute

required

Any of:

integer

integer

>= -9007199254740991 <= 9007199254740991

null

null

maxConcurrency

required

Any of:

integer

integer

>= -9007199254740991 <= 9007199254740991

null

null

createdAt

required

ISO-8601 timestamp

string

updatedAt

required

ISO-8601 timestamp

string

usage

required

Rate-limit defaults and current usage

object

key

additional properties

key

additional properties

Example

{
  "status": "active"
}

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

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

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

404

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

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

X-RateLimit-Limit

integer

Requests allowed per window

X-RateLimit-Remaining

integer

X-RateLimit-Reset

integer

Seconds until the window resets