Skip to main content
POST
/
v1
/
integrations
Create an integration
curl --request POST \
  --url http://localhost:3001/v1/integrations \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider": "<string>",
  "name": "<string>",
  "integrationKey": "<string>",
  "status": "active",
  "credentials": {},
  "config": {}
}
'
{
  "id": "<string>",
  "organizationId": "<string>",
  "provider": "<string>",
  "name": "<string>",
  "integrationKey": "<string>",
  "hasCredentials": true,
  "lastSyncedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "config": {}
}

Headers

authorization
string
Minimum string length: 1
x-organization-id
string
Minimum string length: 1

Body

application/json
provider
string
required
Minimum string length: 1
kind
enum<string>
required
Available options:
provider,
bank,
chain_indexer,
system_of_record
name
string
required
Minimum string length: 1
integrationKey
string
required
Minimum string length: 1
status
enum<string>
default:active
required
Available options:
disabled,
active,
deleted
credentials
object
required
config
object
required

Response

Default Response

id
string
required
organizationId
string
required
provider
string
required
kind
enum<string>
required
Available options:
provider,
bank,
chain_indexer,
system_of_record
name
string
required
integrationKey
string
required
status
enum<string>
required
Available options:
disabled,
active,
deleted
hasCredentials
boolean
required
lastSyncedAt
null | string<date-time>
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
config
object
required