Skip to main content
POST
/
integrations
/
workspace
Create Workspace Integration
curl --request POST \
  --url https://server26-dot-royalti-project.uc.r.appspot.com/integrations/workspace \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "workspaceId": "workspace-123",
  "type": "vertofx",
  "settings": {
    "apiKey": "your-api-key-here",
    "region": "US"
  }
}'
{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "vertofx",
    "enabled": true,
    "settings": {
      "apiKey": "your-api-key-here",
      "region": "US"
    },
    "metadata": {
      "customField": "custom-value"
    },
    "memo": "Integration for VertoFX payments",
    "TenantId": "123e4567-e89b-12d3-a456-426614174000",
    "IntegrationId": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2023-01-01T00:00:00Z",
    "updatedAt": "2023-01-01T00:00:00Z"
  }
}
Creates a new workspace integration. Endpoint: /integrations/workspace
Method: POST
Request Body:
FieldTypeRequiredDescription
workspaceIdstringYesWorkspace ID
typestringYesIntegration type
settingsobjectYesIntegration settings

Authentication

This endpoint requires authentication. Include your bearer token in the Authorization header.

Request Body

Request Schema

FieldTypeRequiredDescription
workspaceIdstringāœ…Workspace ID
typestringāœ…Integration type
settingsobjectāœ…Integration settings

Responses

āœ… 201 - Workspace integration created

āš ļø 400 - undefined

āš ļø 401 - undefined

āŒ 500 - undefined

Tags

Integration

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Body

application/json
workspaceId
string
required

Workspace ID

Example:

"workspace-123"

type
string
required

Integration type

Example:

"vertofx"

settings
object
required

Integration settings

Example:
{
"apiKey": "your-api-key-here",
"region": "US"
}

Response

Workspace integration created

success
boolean
Example:

true

data
object
⌘I