Creates a new workspace integration.
Endpoint: /integrations/workspace
Method: POST
Request Body:
Field | Type | Required | Description |
---|---|---|---|
workspaceId | string | Yes | Workspace ID |
type | string | Yes | Integration type |
settings | object | Yes | Integration settings |
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"
}
}
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Workspace integration created
The response is of type object
.
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"
}
}