reference

Integrations

18 endpoints

Eloqua

POST/api/v3/connector/eloqua/config

Create Configuration

Requires: CONNECTORS_create_config

Request body

EloquaConfig

accountUuid string (uuid)
The account of the org unit, set by wxrks.
active boolean
companyName string
defaultWorkflows string[]
name string
orgUnit ClientIdNameDto
orgUnitUuid string (uuid)
password string
username string
uuid string (uuid)

Responses

201 Created

EloquaConfig

accountUuid string (uuid)
The account of the org unit, set by wxrks.
active boolean
companyName string
defaultWorkflows string[]
name string
orgUnit ClientIdNameDto
orgUnitUuid string (uuid)
password string
username string
uuid string (uuid)

Request

curl -X POST 'https://app.wxrks.com/api/v3/connector/eloqua/config' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "active": false,
  "companyName": "string",
  "defaultWorkflows": [
    "string"
  ],
  "name": "string",
  "orgUnitUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "password": "string",
  "username": "string",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

Response 201

{
  "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "active": false,
  "companyName": "string",
  "defaultWorkflows": [
    "string"
  ],
  "name": "string",
  "orgUnit": {
    "id": 0,
    "name": "string",
    "sourceLanguage": "string",
    "targetLanguage": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "orgUnitUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "password": "string",
  "username": "string",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

PUT/api/v3/connector/eloqua/config

Update Configuration

Requires: CONNECTORS_create_config

Request body

EloquaConfig

accountUuid string (uuid)
The account of the org unit, set by wxrks.
active boolean
companyName string
defaultWorkflows string[]
name string
orgUnit ClientIdNameDto
orgUnitUuid string (uuid)
password string
username string
uuid string (uuid)

Responses

200 OK

EloquaConfig

accountUuid string (uuid)
The account of the org unit, set by wxrks.
active boolean
companyName string
defaultWorkflows string[]
name string
orgUnit ClientIdNameDto
orgUnitUuid string (uuid)
password string
username string
uuid string (uuid)

Request

curl -X PUT 'https://app.wxrks.com/api/v3/connector/eloqua/config' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "active": false,
  "companyName": "string",
  "defaultWorkflows": [
    "string"
  ],
  "name": "string",
  "orgUnitUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "password": "string",
  "username": "string",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

Response 200

{
  "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "active": false,
  "companyName": "string",
  "defaultWorkflows": [
    "string"
  ],
  "name": "string",
  "orgUnit": {
    "id": 0,
    "name": "string",
    "sourceLanguage": "string",
    "targetLanguage": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "orgUnitUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "password": "string",
  "username": "string",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

GET/api/v3/connector/eloqua/config/{configUUID}

Get Configuration

Requires: CONNECTORS_create_config

path parameters

configUUIDrequired string (uuid)

Responses

200 OK

EloquaConfig

accountUuid string (uuid)
The account of the org unit, set by wxrks.
active boolean
companyName string
defaultWorkflows string[]
name string
orgUnit ClientIdNameDto
orgUnitUuid string (uuid)
password string
username string
uuid string (uuid)

Request

curl -X GET 'https://app.wxrks.com/api/v3/connector/eloqua/config/{configUUID}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "active": false,
  "companyName": "string",
  "defaultWorkflows": [
    "string"
  ],
  "name": "string",
  "orgUnit": {
    "id": 0,
    "name": "string",
    "sourceLanguage": "string",
    "targetLanguage": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "orgUnitUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "password": "string",
  "username": "string",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

POST/api/v3/connector/eloqua/sync

Create Project

Requires: PROJECT_create

query parameters

requestId string

Request body

ProjectRequest

accountUUID string (uuid)
configUUID string (uuid)
contactUUID string (uuid)
orgUnitUUID string (uuid)
productTag string
reference string
skipHashCheck boolean
sourceLanguage string
tags string[]
targetLanguages string[]
type string
workflows string[]
wpExcludePaths string[]
wpIds integer (int64)[]
wpPaths string[]

Responses

200 OK

AsyncRequestDto

data object
error object
id string
status stringNEW RUNNING ERROR WARN DONE

Request

curl -X POST 'https://app.wxrks.com/api/v3/connector/eloqua/sync' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "accountUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "configUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "contactUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "orgUnitUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "productTag": "string",
  "reference": "string",
  "skipHashCheck": false,
  "sourceLanguage": "string",
  "tags": [
    "string"
  ],
  "targetLanguages": [
    "string"
  ],
  "type": "string",
  "workflows": [
    "string"
  ],
  "wpExcludePaths": [
    "string"
  ],
  "wpIds": [
    0
  ],
  "wpPaths": [
    "string"
  ]
}'

Response 200

{
  "data": {},
  "error": {},
  "id": "string",
  "status": "NEW"
}

POST/api/v3/connector/eloqua/translation/{projectUUID}

Deliver Translations

Requires: PROJECT_create

path parameters

projectUUIDrequired string (uuid)

query parameters

requestId string
force boolean

Request body

ProjectDeliveryFilters

configPath string
filenames string[]
filepaths string[]
languages string[]
resourceUuids string (uuid)[]
status stringNEW CREATED IN_PROGRESS COMPLETED APPROVED REJECTED DELIVERED CANCELLED FAILED
workflow string

Responses

200 OK

AsyncRequestDto

data object
error object
id string
status stringNEW RUNNING ERROR WARN DONE

Request

curl -X POST 'https://app.wxrks.com/api/v3/connector/eloqua/translation/{projectUUID}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "configPath": "string",
  "filenames": [
    "string"
  ],
  "filepaths": [
    "string"
  ],
  "languages": [
    "string"
  ],
  "resourceUuids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "status": "NEW",
  "workflow": "string"
}'

Response 200

{
  "data": {},
  "error": {},
  "id": "string",
  "status": "NEW"
}

GitHub

POST/api/v3/connector/github/config

Create Configuration

Requires: CONNECTORS_create_config

Request body

GithubConfig

accountUuid string (uuid)
The account of the org unit, set by wxrks.
defaultWorkflows string[]
githubToken string
githubUrl string
githubUser string
name string
orgUnit ClientIdNameDto
orgUnitUuid string (uuid)
uuid string (uuid)

Responses

201 Created

GithubConfig

accountUuid string (uuid)
The account of the org unit, set by wxrks.
defaultWorkflows string[]
githubToken string
githubUrl string
githubUser string
name string
orgUnit ClientIdNameDto
orgUnitUuid string (uuid)
uuid string (uuid)

Request

curl -X POST 'https://app.wxrks.com/api/v3/connector/github/config' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "defaultWorkflows": [
    "string"
  ],
  "githubToken": "string",
  "githubUrl": "string",
  "githubUser": "string",
  "name": "string",
  "orgUnitUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

Response 201

{
  "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "defaultWorkflows": [
    "string"
  ],
  "githubToken": "string",
  "githubUrl": "string",
  "githubUser": "string",
  "name": "string",
  "orgUnit": {
    "id": 0,
    "name": "string",
    "sourceLanguage": "string",
    "targetLanguage": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "orgUnitUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

PUT/api/v3/connector/github/config

Update Configuration

Requires: CONNECTORS_create_config

Request body

GithubConfig

accountUuid string (uuid)
The account of the org unit, set by wxrks.
defaultWorkflows string[]
githubToken string
githubUrl string
githubUser string
name string
orgUnit ClientIdNameDto
orgUnitUuid string (uuid)
uuid string (uuid)

Responses

200 OK

object

Request

curl -X PUT 'https://app.wxrks.com/api/v3/connector/github/config' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "defaultWorkflows": [
    "string"
  ],
  "githubToken": "string",
  "githubUrl": "string",
  "githubUser": "string",
  "name": "string",
  "orgUnitUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

GET/api/v3/connector/github/config/{configUUID}

Get Configuration

Requires: CONNECTORS_create_config

path parameters

configUUIDrequired string (uuid)

Responses

200 OK

GithubConfig

accountUuid string (uuid)
The account of the org unit, set by wxrks.
defaultWorkflows string[]
githubToken string
githubUrl string
githubUser string
name string
orgUnit ClientIdNameDto
orgUnitUuid string (uuid)
uuid string (uuid)

Request

curl -X GET 'https://app.wxrks.com/api/v3/connector/github/config/{configUUID}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "defaultWorkflows": [
    "string"
  ],
  "githubToken": "string",
  "githubUrl": "string",
  "githubUser": "string",
  "name": "string",
  "orgUnit": {
    "id": 0,
    "name": "string",
    "sourceLanguage": "string",
    "targetLanguage": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "orgUnitUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

GET/api/v3/connector/github/config/{configUUID}/repo

Get Repository Configurations

Requires: CONNECTORS_create_config

path parameters

configUUIDrequired string (uuid)

Responses

200 OK

RepositoryConfig[]

baseBranchrequired string
configPathrequired string
configUUID string (uuid)
fileSuffix string
id integer (int64)
Leave it out to create a repository configuration; send the id of one of this GitHub configuration's repository configurations to update it.
namerequired string
ownerrequired string
projectTagrequired string
uuid string (uuid)

Request

curl -X GET 'https://app.wxrks.com/api/v3/connector/github/config/{configUUID}/repo' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

[
  {
    "baseBranch": "string",
    "configPath": "string",
    "configUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "fileSuffix": "string",
    "id": 0,
    "name": "string",
    "owner": "string",
    "projectTag": "string",
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
]

POST/api/v3/connector/github/config/{configUUID}/repo

Upsert Repository Configurations

Requires: CONNECTORS_create_config

Two repository configurations of one GitHub configuration can't share the same repository (name and owner), configPath and baseBranch, even with different projectTags: deleteRepositoryConfiguration finds a repository configuration by them. A configuration that repeats another's is rejected, and none of the list is saved.

path parameters

configUUIDrequired string (uuid)

Request body

RepositoryConfig[]

baseBranchrequired string
configPathrequired string
configUUID string (uuid)
fileSuffix string
id integer (int64)
Leave it out to create a repository configuration; send the id of one of this GitHub configuration's repository configurations to update it.
namerequired string
ownerrequired string
projectTagrequired string
uuid string (uuid)

Responses

200 OK

object

Request

curl -X POST 'https://app.wxrks.com/api/v3/connector/github/config/{configUUID}/repo' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[
  {
    "name": "docs-site",
    "owner": "example-org",
    "baseBranch": "main",
    "configPath": "wxrks.yml",
    "projectTag": "docs-site",
    "fileSuffix": "-l10n"
  }
]'

DELETE/api/v3/connector/github/config/{configUUID}/repo/{name}/owner/{owner}/config-path/{configPath}/base-branch/{baseBranch}

Delete Repository Configuration

Requires: CONNECTORS_create_config

path parameters

configUUIDrequired string (uuid)
namerequired string
ownerrequired string
configPathrequired string
baseBranchrequired string

Responses

200 OK

object

Request

curl -X DELETE 'https://app.wxrks.com/api/v3/connector/github/config/{configUUID}/repo/{name}/owner/{owner}/config-path/{configPath}/base-branch/{baseBranch}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

POST/api/v3/connector/github/sync

Create Project

Requires: PROJECT_create

query parameters

requestId string

Request body

ProjectRequest

accountUUID string (uuid)
configUUID string (uuid)
contactUUID string (uuid)
orgUnitUUID string (uuid)
productTag string
reference string
skipHashCheck boolean
sourceLanguage string
tags string[]
targetLanguages string[]
type string
workflows string[]
wpExcludePaths string[]
wpIds integer (int64)[]
wpPaths string[]

Responses

200 OK

AsyncRequestDto

data object
error object
id string
status stringNEW RUNNING ERROR WARN DONE

Request

curl -X POST 'https://app.wxrks.com/api/v3/connector/github/sync' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "accountUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "configUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "contactUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "orgUnitUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "productTag": "string",
  "reference": "string",
  "skipHashCheck": false,
  "sourceLanguage": "string",
  "tags": [
    "string"
  ],
  "targetLanguages": [
    "string"
  ],
  "type": "string",
  "workflows": [
    "string"
  ],
  "wpExcludePaths": [
    "string"
  ],
  "wpIds": [
    0
  ],
  "wpPaths": [
    "string"
  ]
}'

Response 200

{
  "data": {},
  "error": {},
  "id": "string",
  "status": "NEW"
}

POST/api/v3/connector/github/translation/{projectUUID}

Deliver Translations

Requires: PROJECT_create

path parameters

projectUUIDrequired string (uuid)

query parameters

requestId string
force boolean
writeToS3 boolean
writeToDisk boolean
skipGitHub boolean
skipDatabaseUpdate boolean
createSeparateOutputFolder boolean
skipBuildTranslatedFile boolean

Request body

ProjectDeliveryFilters

configPath string
filenames string[]
filepaths string[]
languages string[]
resourceUuids string (uuid)[]
status stringNEW CREATED IN_PROGRESS COMPLETED APPROVED REJECTED DELIVERED CANCELLED FAILED
workflow string

Responses

200 OK

AsyncRequestDto

data object
error object
id string
status stringNEW RUNNING ERROR WARN DONE

Request

curl -X POST 'https://app.wxrks.com/api/v3/connector/github/translation/{projectUUID}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "configPath": "string",
  "filenames": [
    "string"
  ],
  "filepaths": [
    "string"
  ],
  "languages": [
    "string"
  ],
  "resourceUuids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "status": "NEW",
  "workflow": "string"
}'

Response 200

{
  "data": {},
  "error": {},
  "id": "string",
  "status": "NEW"
}

WordPress

POST/api/v3/connector/wordpress/config

Create Configuration

Requires: CONNECTORS_create_config

Request body

WordPressConfig

accountUuid string (uuid)
The account of the org unit, set by wxrks.
baseUrlrequired string
cloudflareClientId string
cloudflareClientSecret string
defaultWorkflows string[]
namerequired string
orgUnit ClientIdNameDto
orgUnitUuidrequired string (uuid)
params map<string, object>
sourceSite string
strategy stringDEFAULT ZENDESK
uuid string (uuid)
wpCookiePassword string
wpCookieUser string
wpPasswordrequired string
wpUserrequired string

Responses

201 Created

WordPressConfig

accountUuid string (uuid)
The account of the org unit, set by wxrks.
baseUrlrequired string
cloudflareClientId string
cloudflareClientSecret string
defaultWorkflows string[]
namerequired string
orgUnit ClientIdNameDto
orgUnitUuidrequired string (uuid)
params map<string, object>
sourceSite string
strategy stringDEFAULT ZENDESK
uuid string (uuid)
wpCookiePassword string
wpCookieUser string
wpPasswordrequired string
wpUserrequired string

Request

curl -X POST 'https://app.wxrks.com/api/v3/connector/wordpress/config' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Company blog",
  "orgUnitUuid": "6b1f0c2e-8d4a-4f3b-9c5e-2a7d9e1b4c60",
  "baseUrl": "https://blog.example.com",
  "wpUser": "wxrks-integration",
  "wpPassword": "wp-application-password",
  "defaultWorkflows": [
    "TRANSLATION"
  ],
  "strategy": "DEFAULT"
}'

Response 201

{
  "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "baseUrl": "string",
  "cloudflareClientId": "string",
  "cloudflareClientSecret": "string",
  "defaultWorkflows": [
    "string"
  ],
  "name": "string",
  "orgUnit": {
    "id": 0,
    "name": "string",
    "sourceLanguage": "string",
    "targetLanguage": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "orgUnitUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "params": {},
  "sourceSite": "string",
  "strategy": "DEFAULT",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "wpCookiePassword": "string",
  "wpCookieUser": "string",
  "wpPassword": "string",
  "wpUser": "string"
}

PUT/api/v3/connector/wordpress/config

Update Configuration

Requires: CONNECTORS_create_config

Request body

WordPressConfig

accountUuid string (uuid)
The account of the org unit, set by wxrks.
baseUrlrequired string
cloudflareClientId string
cloudflareClientSecret string
defaultWorkflows string[]
namerequired string
orgUnit ClientIdNameDto
orgUnitUuidrequired string (uuid)
params map<string, object>
sourceSite string
strategy stringDEFAULT ZENDESK
uuid string (uuid)
wpCookiePassword string
wpCookieUser string
wpPasswordrequired string
wpUserrequired string

Responses

200 OK

WordPressConfig

accountUuid string (uuid)
The account of the org unit, set by wxrks.
baseUrlrequired string
cloudflareClientId string
cloudflareClientSecret string
defaultWorkflows string[]
namerequired string
orgUnit ClientIdNameDto
orgUnitUuidrequired string (uuid)
params map<string, object>
sourceSite string
strategy stringDEFAULT ZENDESK
uuid string (uuid)
wpCookiePassword string
wpCookieUser string
wpPasswordrequired string
wpUserrequired string

Request

curl -X PUT 'https://app.wxrks.com/api/v3/connector/wordpress/config' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "uuid": "5e0b3c8a-7f2d-4a61-9b4e-1d6c8a2f0e97",
  "name": "Company blog",
  "orgUnitUuid": "6b1f0c2e-8d4a-4f3b-9c5e-2a7d9e1b4c60",
  "baseUrl": "https://blog.example.com",
  "wpUser": "wxrks-integration",
  "wpPassword": "wp-application-password",
  "defaultWorkflows": [
    "TRANSLATION",
    "REVIEW"
  ],
  "strategy": "DEFAULT"
}'

Response 200

{
  "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "baseUrl": "string",
  "cloudflareClientId": "string",
  "cloudflareClientSecret": "string",
  "defaultWorkflows": [
    "string"
  ],
  "name": "string",
  "orgUnit": {
    "id": 0,
    "name": "string",
    "sourceLanguage": "string",
    "targetLanguage": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "orgUnitUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "params": {},
  "sourceSite": "string",
  "strategy": "DEFAULT",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "wpCookiePassword": "string",
  "wpCookieUser": "string",
  "wpPassword": "string",
  "wpUser": "string"
}

GET/api/v3/connector/wordpress/config/{configUUID}

Get Configuration

Requires: CONNECTORS_create_config

path parameters

configUUIDrequired string (uuid)

Responses

200 OK

WordPressConfig

accountUuid string (uuid)
The account of the org unit, set by wxrks.
baseUrlrequired string
cloudflareClientId string
cloudflareClientSecret string
defaultWorkflows string[]
namerequired string
orgUnit ClientIdNameDto
orgUnitUuidrequired string (uuid)
params map<string, object>
sourceSite string
strategy stringDEFAULT ZENDESK
uuid string (uuid)
wpCookiePassword string
wpCookieUser string
wpPasswordrequired string
wpUserrequired string

Request

curl -X GET 'https://app.wxrks.com/api/v3/connector/wordpress/config/{configUUID}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "baseUrl": "string",
  "cloudflareClientId": "string",
  "cloudflareClientSecret": "string",
  "defaultWorkflows": [
    "string"
  ],
  "name": "string",
  "orgUnit": {
    "id": 0,
    "name": "string",
    "sourceLanguage": "string",
    "targetLanguage": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "orgUnitUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "params": {},
  "sourceSite": "string",
  "strategy": "DEFAULT",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "wpCookiePassword": "string",
  "wpCookieUser": "string",
  "wpPassword": "string",
  "wpUser": "string"
}

POST/api/v3/connector/wordpress/sync

Create Project

Requires: PROJECT_create

query parameters

requestId string

Request body

ProjectRequest

accountUUID string (uuid)
configUUID string (uuid)
contactUUID string (uuid)
orgUnitUUID string (uuid)
productTag string
reference string
skipHashCheck boolean
sourceLanguage string
tags string[]
targetLanguages string[]
type string
workflows string[]
wpExcludePaths string[]
wpIds integer (int64)[]
wpPaths string[]

Responses

200 OK

AsyncRequestDto

data object
error object
id string
status stringNEW RUNNING ERROR WARN DONE

Request

curl -X POST 'https://app.wxrks.com/api/v3/connector/wordpress/sync' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "accountUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "configUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "contactUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "orgUnitUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "productTag": "string",
  "reference": "string",
  "skipHashCheck": false,
  "sourceLanguage": "string",
  "tags": [
    "string"
  ],
  "targetLanguages": [
    "string"
  ],
  "type": "string",
  "workflows": [
    "string"
  ],
  "wpExcludePaths": [
    "string"
  ],
  "wpIds": [
    0
  ],
  "wpPaths": [
    "string"
  ]
}'

Response 200

{
  "data": {},
  "error": {},
  "id": "string",
  "status": "NEW"
}

POST/api/v3/connector/wordpress/translation/{projectUUID}

Deliver Translations

Requires: PROJECT_create

path parameters

projectUUIDrequired string (uuid)

query parameters

requestId string
force boolean

Request body

ProjectDeliveryFilters

configPath string
filenames string[]
filepaths string[]
languages string[]
resourceUuids string (uuid)[]
status stringNEW CREATED IN_PROGRESS COMPLETED APPROVED REJECTED DELIVERED CANCELLED FAILED
workflow string

Responses

200 OK

AsyncRequestDto

data object
error object
id string
status stringNEW RUNNING ERROR WARN DONE

Request

curl -X POST 'https://app.wxrks.com/api/v3/connector/wordpress/translation/{projectUUID}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "configPath": "string",
  "filenames": [
    "string"
  ],
  "filepaths": [
    "string"
  ],
  "languages": [
    "string"
  ],
  "resourceUuids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "status": "NEW",
  "workflow": "string"
}'

Response 200

{
  "data": {},
  "error": {},
  "id": "string",
  "status": "NEW"
}