Skip to content
LabelyardLabelyardLabelyard

Test an integration with unsaved form values

POST
/api/v1/settings/integrations/{name}/test
curl --request POST \
  --url https://example.com/api/v1/settings/integrations/example/test \
  --header 'Content-Type: application/json' \
  --header 'X-Label-Hub-Key: <X-Label-Hub-Key>' \
  --data '{ "values": {} }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
name
required
Name
string

Request Body

Section titled “Request Body”
Media typeapplication/json
IntegrationTestRequest

Documented request body of the test-connection route (parsed by hand).

object
values
Values
object
key
additional properties
any

Example generated

{
  "values": {}
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
IntegrationTestResult
object
detail
required
Detail
string
ok
required
Ok
boolean
status
Status
Any of:
integer

Example generated

{
  "detail": "example",
  "ok": true,
  "status": 1
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}