Configure Integration

POST /api/v1/integrations

Configure Integration

cURL

curl --request POST \
  --url https://api.veridical.dev/api/v1/integrations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "credential_ref": "<string>",
  "display_name": "<string>",
  "external_id": "<string>",
  "provider": "<string>",
  "workspace_id": "<string>",
  "client_request_id": "<string>",
  "config": {},
  "scopes": [
    "<string>"
  ],
  "state": "active"
}
'

201

{}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key · string | null

Required string length: 8 - 200

X-Correlation-ID · string | null

authorization · string | null

Body

application/json

credential_ref · string · required

Required string length: 10 - 1000

Pattern: ^(gcp-sm|azure-kv|vault)://

display_name · string · required

Required string length: 1 - 200

external_id · string · required

Required string length: 1 - 300

provider · string · required

Pattern: ^(slack|teams|jira|linear|confluence|webhook)$

workspace_id · string · required

client_request_id · string | null

Required string length: 8 - 200

config · Config · object

scopes · string[]

Maximum array length: 100

state · string · default: active

Pattern: ^(active|disabled)$

Response

201

application/json

Successful Response

The response is of type Response Configure Integration Api V1 Integrations Post · object.