Skip to content
Browse documentation

OpenAPI operations

Send one real request to a saved destination without recording a delivery

POST
/v1/destinations/{id}/test-connection
curl --request POST \
  --url https://api.hooks.events/v1/destinations/example/test-connection \
  --header 'Authorization: Bearer <token>'

Requires the endpoints:write scope.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
ok
required

Whether the target answered with a 2xx status

boolean
status
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
durationMs
required

Time from request start to response, in milliseconds

number
responseBody
required

Response body, capped at 64 KiB and with destination secrets redacted

string | null
request
required
Any of:
object
url
required
string
method
required
string
headers
required

Credential headers replaced by [redacted]

object
key
additional properties
string
hasBody
required
boolean
errorCode
required

OUTBOUND_REQUEST_INVALID, OUTBOUND_REQUEST_BLOCKED, OAUTH_TOKEN_FAILED, GCP_TOKEN_FAILED or OUTBOUND_REQUEST_FAILED

string | null
errorMessage
required
string | null
key
additional properties

Example generated

{
  "ok": true,
  "status": 1,
  "durationMs": 1,
  "responseBody": "example",
  "request": {
    "url": "example",
    "method": "example",
    "headers": {
      "additionalProperty": "example"
    },
    "hasBody": true
  },
  "errorCode": "example",
  "errorMessage": "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"
  }
}

404

Section titled “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

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