Skip to main content
POST
/
core.v1.IntegrationBIService
/
CreateBIIntegration
cURL
curl -X POST "https://api.joinformal.com/core.v1.IntegrationBIService/CreateBIIntegration" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'
{
  "integration": {
    "id": "<string>",
    "name": "<string>",
    "createdAt": "2023-01-15T01:30:15.01Z",
    "linkedDbUserId": "<string>",
    "sync": true,
    "fivetran": {
      "apiKey": "<string>",
      "apiSecret": "<string>"
    }
  }
}

Authorizations

X-API-KEY
string
header
required

API key authentication. Get your API key from the Formal dashboard.

Body

application/json
  • CreateBIIntegrationRequest
  • CreateBIIntegrationRequest
fivetran
object
required
name
string
Minimum length: 1
linkedDbUserId
string
sync
boolean

Response

Success

integration
object
  • integration
  • integration