APIs

This section provides the details on the REST APIs used in the integration.

API- Creates a new external WFM configuration for a specified vendor.

Description

Creates a new external WFM configuration for a specified vendor.
Authentication Required

Yes (Bearer token in Authorization header)
URL

/wfm-integration/v1/externalWfmConfiguration/external-wfm-confgurations

Method

POST
Request

Content-Type: application/json
Request Body Fields

Field

Type

Req

description

wfm_id

int

Yes

The vendor ID for the external WFM.

name

string

Yes

The name of the configuration.

config

JSON object

Yes

Configuration details. Accepts any key-value pairs.

secrets

JSON objectg

No

Secrets for the configuration.
active boolean No Indicates if the configuration is active.
Request Body
var(--codeSnippetCopyLabel) 
{
  "wfm_id": 2,
  "name": "FORD's Verint Configuration",
  "config": {
    "region": "US",
    "client_id": "NICE_VERINT_CLIENT",
    "data_source": "NICE_ACD_DS"
  },
  "secrets": {
    "client_secret": "NICE_VERINT_CLIENT_SECRET"
  },
  "active": false
}

Response Data
var(--codeSnippetCopyLabel) 
{
  "config_id": 123,
  "wfm_id": 2,
  "name": "FORD's Verint Configuration",
  "kms_key_identifier": "kms-key-123",
  "config": {
    "region": "US",
    "client_id": "NICE_VERINT_CLIENT",
    "data_source": "NICE_ACD_DS"
  },
  "encrypted_secrets": "base64string",
  "active": false
}
Success Response 200 Created

Response Body Fields

Field

Type

Notes

config_id

int

Unique identifier for the configuration.

wfm_id

int

Vendor ID associated with the configuration.

name

string

Name of the configuration.

kms_key_identifier

string

KMS key identifier used for encrypting and decrypting secrets.
config JSON object Configuration details with dynamic key-value fields.
encrypted_secrets string Base64-encoded string containing encrypted secrets.
active boolean Indicates whether the configuration is active.

Error Response

http

meaning

typical cause

 Response
400 Bad Request The request is invalid. Missing required fields, invalid argument values, or validation failures (e.g., wfm_id is zero, name is empty, config is null, or vendor ID does not exist). Invalid argument provided for external WFM configuration.
401 Unauthorized Authentication failed. Missing or invalid authentication token. Failed to authenticate.
404 Not Found Resource not found. The specified vendor or configuration does not exist. Not found
409 Conflict Invalid operation. Business rule violation, such as duplicate configuration or other logical conflicts. Invalid operation while adding external WFM configuration.
500 Internal Server Error Unexpected server error. Unhandled exceptions or system failures. Internal server error while adding external WFM configuration.

Sample Call
var(--codeSnippetCopyLabel) 
curl -X POST "https://<host>/wfm-integration/v1/external-wfm-configurations" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "wfm_id": 2,
    "name": "FORD'\''s Verint Configuration",
    "config": {
      "region": "US",
      "client_id": "NICE_VERINT_CLIENT",
      "data_source": "NICE_ACD_DS"
    },
    "secrets": {
      "client_secret": "NICE_VERINT_CLIENT_SECRET"
    },
    "active": false
  }'

Notes

  • The request body must be present and valid.

  • wfm_id, name, and config are required and must not be empty.

  • The specified wfm_id must exist in the vendors table.

  • If any validation fails, a 400 Bad Request is returned with a descriptive message.

  • All secrets are encrypted and stored securely.

API: Update External WFM Configuration

Description

  • Updates an existing external WFM configuration identified by id.

  • Allows modification of configuration details for a specific WFM vendor.
Authentication Required Yes. Bearer token in the Authorization header.
URL /wfm-integration/v1/externalWfmConfiguration/external-wfm-confgurations/{id}
Method PUT
Request Content-Type: application/json
Request Body Fields

Field

Type

Req

description

wfm_id

int

Yes

The vendor ID for the external WFM.

name

string

Yes

The name of the configuration.

config

JSON object

Yes

Configuration details. Accepts any key-value pairs.

secrets

JSON objectg

No

Secrets for the configuration.
active boolean No Indicates if the configuration is active.
Request Body
var(--codeSnippetCopyLabel) 
{
  "wfm_id": 2,
  "name": "FORD's Verint Configuration",
  "config": {
    "region": "US",
    "client_id": "NICE_VERINT_CLIENT",
    "data_source": "NICE_ACD_DS"
  },
  "secrets": {
    "client_secret": "NICE_VERINT_CLIENT_SECRET"
  },
  "active": false
}

Response Data
var(--codeSnippetCopyLabel) 
{
  "config_id": 123,
  "wfm_id": 2,
  "name": "FORD's Verint Configuration",
  "kms_key_identifier": "kms-key-123",
  "config": {
    "region": "US",
    "client_id": "NICE_VERINT_CLIENT",
    "data_source": "NICE_ACD_DS"
  },
  "encrypted_secrets": "base64string",
  "active": false
}
Success Response 201 Created

Response Body Fields

Field

Type

description

config_id

int

Unique identifier for the configuration.

wfm_id

int

Vendor ID associated with the configuration.

name

string

Name of the configuration.

kms_key_identifier

string

KMS key identifier used for encrypting and decrypting secrets.
config JSON object Configuration details with dynamic key-value fields.
encrypted_secrets string Base64-encoded string containing encrypted secrets.
active boolean Indicates whether the configuration is active.

Error Response

http

meaning

typical cause

 Response
400 Bad Request The request is invalid. Missing required fields, invalid argument values, or validation failures (e.g., wfm_id is zero, name is empty, config is null, or vendor ID does not exist). Invalid argument provided for external WFM configuration.
401 Unauthorized Authentication failed. Missing or invalid authentication token. Failed to authenticate.
404 Not Found Resource not found. The specified vendor or configuration does not exist. Not found
409 Conflict Invalid operation. Business rule violation, such as duplicate configuration or other logical conflicts. Invalid operation while adding external WFM configuration.
500 Internal Server Error Unexpected server error. Unhandled exceptions or system failures. Internal server error while adding external WFM configuration.

Sample Call
var(--codeSnippetCopyLabel) 
curl -X POST "https://<host>/wfm-integration/v1/external-wfm-configurations" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "wfm_id": 2,
    "name": "FORD'\''s Verint Configuration",
    "config": {
      "region": "US",
      "client_id": "NICE_VERINT_CLIENT",
      "data_source": "NICE_ACD_DS"
    },
    "secrets": {
      "client_secret": "NICE_VERINT_CLIENT_SECRET"
    },
    "active": false
  }'

Notes

  • The request body must be present and valid.

  • id, wfm_id, name, and config are required and must not be empty.

  • The specified wfm_id must exist in the vendors table.

  • If any validation fails, a 400 Bad Request is returned with a descriptive message.

  • All secrets are encrypted and stored securely.

  • If the configuration with the given id does not exist, returns a 400 Bad Request or 404 Not Found.

  • If the update is successful, returns the updated configuration with status 200 OK.

  • If the update fails due to a database error or other exception, returns a 500 Internal Server Error message.

Get External WFM Configuration by ID

Description

 Gets active configuration matching specified config id
Authentication Required Authentication is required (Bearer token in the Authorization header).
URL

/wfm-integration/v1/externalWfmConfiguration/external-wfm-configurations

Method GET
Request Content-Type: application/json
Request Body Fields

Field

Type

description
id int ID from list of external configurations to get configuration details.
Request Body
var(--codeSnippetCopyLabel) 
{
  "wfm_id": 2,
}
Response Data
var(--codeSnippetCopyLabel) 
{
  "wfm": {
    "wfm_Id": 2,
    "code": "verint",
    "s3_Root_Path": "verintwfm",
    "metadata": {
      "regionalRootURL": {
        "EU": "https://apigw.eu-central-1.wrk-1.aws.hydra.verint.com",
        "US": "https://apigw.us-east-1.wrk-1.aws.hydra.verint.com",
        "APAC": "https://apigw.ap-southeast-2.wrk-1.aws.hydra.verint.com"
      }
    }
  },
  "config_Id": 2,
  "wfm_Id": 2,
  "name": null,
  "kms_Key_Identifier": "arn:aws:kms:us-west-2:265671366761:key/e8300dad-86b3-4921-a8b2-83f86a3f59fa",
  "config": {
    "region": "US",
    "client_Id": "NICE_VERINT_CLIENT",
    "data_Source": "NICE_ACD_DS"
  },
  "encrypted_Secrets": "AQICAHiygt+lV82YtT7PLsRfjRRT9CnHDmHPJ19go32D0ls9JAH0eTJOsZVHVL0VPdIZqWQhAAA
                        AdzB1BgkqhkiG9w0BBwagaDBmAgEAMGEGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMMuUpOq
                        Z/T0BQDe/ZAgEQgDQped5uxE4TBPkx/xgabO+70m9UTZkSfGRVqb691h/Jw6cWqskuhNAMEVM97DkvUYAfLZIv",
  "active": true
}
Success Response 200 Success

Response Body Fields

Field

Type

description

config_id

int

Unique identifier for the configuration.

wfm_id

int

Vendor ID associated with the configuration.

name

string

Name of the configuration.

kms_key_identifier

string

KMS key identifier used for encrypting and decrypting secrets.
config JSON object Configuration details with dynamic key-value fields.
encrypted_secrets string Base64-encoded string containing encrypted secrets.
active boolean Indicates whether the configuration is active.
wfm JSON object Object containing vendor details

Error Response

http

meaning

typical cause

 Response
401 Unauthorized Authentication failed. Missing or invalid authentication token. Failed to authenticate.
404 Not Found Resource not found. No WFM Configurations found for the given id. Not found
409 Conflict Invalid operation. Business rule violation, such as duplicate configuration or other logical conflicts. Invalid operation while adding external WFM configuration.
500 Internal Server Error Unexpected server error. Unhandled exceptions or system failures. Internal server error while adding external WFM configuration.

Sample Call
var(--codeSnippetCopyLabel) 
curl -X 'GET' \
  'http://wfm-config-na1.integrations.test.internal/wfm-integration/v1/externalWfmConfig/external-wfm-configurations/2' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJzZXJ2aWNlOjEyMzQ1Njc4OTAiLCJuYW1lIjoiSm9obi
   BEb2UiLCJhZG1pbiI6dHJ1ZSwiaWF0IjoxNzYyODU3NTc3LCJleHAiOjE3NjI4NjExNzd9.dTwyZ0i5rVkQ16HAKczChMSg96Hv7lNhE4l07psjwhY'

Notes

  • Authentication is required (Bearer token in the Authorization header).

  • The path parameter id must be a valid configuration ID.

API: Get External WFM Configurations

Description

 ID from list of external configurations to get configuration details
Authentication Required Authentication is required (Bearer token in the Authorization header).
URL

/wfm-integration/v1/externalWfmConfiguration/external-wfm-configurations

Method GET
Request Content-Type: application/json
Request Body Fields

Field

Type

Description
active boolean

Filter by active status:

  • true = only active,

  • false = only inactive,

  • omit or leave blank to include all
Response Data
var(--codeSnippetCopyLabel) 
[
  {
    "config_Id": 1,
    "wfm_Id": 2,
    "name": "Ford",
    "active": false
  }
]
Success Response 200 Success

Response Body Fields

Field

Type

description

config_id

int

Unique identifier for the configuration.

wfm_id

int

Vendor ID associated with the configuration.

name

string

Name of the configuration.
active boolean Indicates whether the configuration is active.

Error Response

http

meaning

typical cause

 Response
401 Unauthorized Authentication failed. Missing or invalid authentication token. Failed to authenticate.
409 Conflict Invalid operation. Business rule violation, such as duplicate configuration or other logical conflicts. Invalid operation while adding external WFM configuration.
500 Internal Server Error Unexpected server error. Unhandled exceptions or system failures. Internal server error while adding external WFM configuration.

Sample Call
var(--codeSnippetCopyLabel) 
curl -X 'GET' \
  'http://wfm-config-na1.integrations.test.internal/wfm-integration/v1/externalWfmConfig/external-wfm-configurations/2' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJzZXJ2aWNlOjEyMzQ1Njc4OTAiLCJuYW1lIjoiSm9obi
   BEb2UiLCJhZG1pbiI6dHJ1ZSwiaWF0IjoxNzYyODU3NTc3LCJleHAiOjE3NjI4NjExNzd9.dTwyZ0i5rVkQ16HAKczChMSg96Hv7lNhE4l07psjwhY'

Notes

  • Authentication is required (Bearer token in the Authorization header).

  • The query parameter active is optional.

  • If active is omitted, all configurations are returned.

API: Get Enumeration of Available External WFM Vendors

Description

 Get Enumeration of available External WFM Vendors.
Authentication Required Authentication is required (Bearer token in the Authorization header).
URL

/wfm-integration/v1/externalWfmConfiguration/external-wfms

Method GET
Request Content-Type: application/json
   
Response Data
var(--codeSnippetCopyLabel) 
[
  {
    "wfm_Id": 2,
    "code": "verint",
    "s3_Root_Path": "verintwfm",
    "metadata": {
      "regionalRootURL": {
        "EU": "https://apigw.eu-central-1.wrk-1.aws.hydra.verint.com",
        "US": "https://apigw.us-east-1.wrk-1.aws.hydra.verint.com",
        "APAC": "https://apigw.ap-southeast-2.wrk-1.aws.hydra.verint.com"
      }
    }
  }
]
Success Response 200 Success

Response Body Fields

Field

Type

description

wfm_id

 int Unique identifier for the vendor.
Code string Name of the vendor.

s3_Root_Path

 string Name of the S3 bucket associated with the relevant vendor.
metadata JSON object Configuration details with dynamic key-value pair.

Error Response

http

meaning

typical cause

 Response
401 Unauthorized Authentication failed. Missing or invalid authentication token. Failed to authenticate.
404 Not Found Resource not found. No WFM Vendors configured. Not found.
409 Conflict Invalid operation. Business rule violation, such as duplicate configuration or other logical conflicts. Invalid operation while adding external WFM configuration.
500 Internal Server Error Unexpected server error. Unhandled exceptions or system failures. Internal server error while adding external WFM configuration.

Sample Call
var(--codeSnippetCopyLabel) 
curl -X 'GET' \
  'http://wfm-config-na1.integrations.test.internal/wfm-integration/v1/externalWfmConfig/external-wfms' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJzZXJ2aWNlOjEyMzQ1Njc4OTAiLC
                     JuYW1lIjoiSm9obiBEb2UiLCJhZG1pbiI6dHJ1ZSwiaWF0IjoxNzYyODU3NTc3LCJleHAiOjE3NjI4NjEx
                     Nzd9.dTwyZ0i5rVkQ16HAKczChMSg96Hv7lNhE4l07psjwhY'

Notes

  • Authentication is required (Bearer token in the Authorization header).

API: Linking Tenant with One or More External WFM Configurations

Description

 Links Tenant with one or more external wfm configurations, replaces prior linked configurations.
Authentication Required Authentication is required (Bearer token in the Authorization header).
URL

/wfm-integration/v1/externalWfmConfiguration/external-wfms-links

Method POST
Request Content-Type: application/json
Request Data
var(--codeSnippetCopyLabel) 
[
  {
    "wfm_config_id": 1234,
    "division_id": 79,
    "metadata": {
      "report_capture_tz": "America/Chicago",
      "data_source": "NICE_ACD_DS1"
    }
  }
]
Request Body Fields

Field

Type

 Required

Description
wfm_config_id int Yes Unique identifier for the External WFM Configuration.
division_id int No The unique identifier for division within a tenant.
metadata JSON Object No Relation configuration details with dynamic key-value pairs.
Response Data
var(--codeSnippetCopyLabel) 
[
  {
    "wfm_config_id": 1234,
    "division_id": 79,
    "metadata": {
      "report_capture_tz": "America/Chicago",
      "data_source": "NICE_ACD_DS1"
    }
  }
]
Success Response 200 Success

Response Body Fields

Field

Type

description

wfm_config_id

 int Unique identifier for the External WFM Configuration.
division_id int The unique identifier for division within a tenant.
metadata JSON Object Configuration details with dynamic key-value pair.
     

Error Response

http

meaning

typical cause

 Response
400 Bad Request Invalid Request WFM Configuration doesn’t exist or is not provided in the request. Bad Request
401 Unauthorized Authentication failed Missing or invalid authentication token. Failed to authenticate
404 Not Found Resource not found No WFM links found for the given Tenant Id. Not found
409 Conflict Invalid operation. Business rule violation, such as duplicate configuration or other logical conflicts. Invalid operation while linking external WFM configuration with Tenants.
500 Internal Server Error Unexpected server error Unhandled exceptions or system failures. Internal server error while linking external wfm configurations

Sample Call
var(--codeSnippetCopyLabel) 
curl -X 'POST' \
  'http://wfm-config-na1.integrations.test.internal/wfm-integration/v1/externalWfmConfig/tenant/11e7f51c-79d7-4550-b322-0242ac110002/external-wfm-links' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJzZXJ2aWNlOjEyMzQ1Njc4OTAiLCJuYW1lIjoiSm9obiBEb2UiLCJhZG1pbiI6dHJ1ZSwiaWF0IjoxNz
                     YzNDYwODg5LCJleHAiOjE3NjM0NjQ0ODl9.P0SqraOtH1J5SFrsVwFER3l0lANCk7jif5HGFw5sGI8' \
  -H 'Content-Type: application/json' \
  -d '[
  {
    "wfm_config_id": 1234,
    "division_id": 79,
    "metadata": {
      "report_capture_tz": "America/Chicago",
      "data_source": "NICE_ACD_DS1"
    }
  }
]'

Notes

  • Authentication is required (Bearer token in the Authorization header).

  • No request parameters or body are required.

API: For Getting Data for Linked WFM Configurations

Description

 Returns all linked to the specified {tenantId} external wfm configurations.
Authentication Required Authentication is required (Bearer token in the Authorization header).
URL

/wfm-integration/v1/externalWfmConfiguration/external-wfms-links

Method GET
Request Content-Type: application/json
Request Parameters

Field

Type

Description
tenantId string User Hub Tenant ID.
Request Body Fields

Field

Type

 Required

Description
wfm_config_id int Yes Unique identifier for the External WFM Configuration.
division_id int No The unique identifier for division within a tenant.
metadata JSON Object No Relation configuration details with dynamic key-value pairs.
Response Data
var(--codeSnippetCopyLabel) 
[
  {
    "wfm_config_id": 4,
    "division_id": 2345,
    "metadata": {
      "report_capture_tz": "America/Chicago",
      "data_source": "NICE_ACD_DS1"
    }
  },
  {
    "wfm_config_id": 7,
    "division_id": 2,
    "metadata": {
      "report_capture_tz": "US/Central",
      "data_source": "NICE_ACD_DS"
    }
  }
]
Success Response 200 Success

Response Body Fields

Field

Type

description

wfm_config_id

 int Unique identifier for the External WFM Configuration.
division_id int The unique identifier for division within a tenant.
metadata JSON Object Configuration details with dynamic key-value pair.
     

Error Response

http

meaning

typical cause

 Response
401 Unauthorized Authentication failed Missing or invalid authentication token. Failed to authenticate
404 Not Found Resource not found No WFM links found for the given Tenant Id. Not found
409 Conflict Invalid operation. Business rule violation, such as duplicate configuration or other logical conflicts. Invalid operation while linking external WFM configuration with Tenants.
500 Internal Server Error Unexpected server error Unhandled exceptions or system failures. Internal server error while linking external wfm configurations

Sample Call
var(--codeSnippetCopyLabel) 
curl -X 'GET' \
  'http://wfm-config-na1.integrations.test.internal/wfm-integration/v1/externalWfmConfig/tenant/11e85283-2a5d-bda0-904d-0242ac110008/external-wfm-links' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJzZXJ2aWNlOjEyMzQ1Njc4OTAiLCJuYW1lIjoiSm9obiBEb2UiLCJhZG1pbiI6dHJ1ZSwiaWF0IjoxNz
                     YzNDY1MTc3LCJleHAiOjE3NjM0Njg3Nzd9.sN1AKKya0WK4s8iz1a32pLCvwpQhMld_RlxuoXBQ5Sc'

Notes

  • Authentication is required (Bearer token in the Authorization header).

API: For Getting Information Related to the Specified BU

Description

 Returns all linked to the specified bu external wfm configurations
Authentication Required Authentication is required (Bearer token in the Authorization header).
URL

/wfm-integration/v1/externalWfmConfiguration/external-wfms-links

Method GET
Request Content-Type: application/json
Request Parameters

Field

Type

Description
busno int Business unit number
Response Data
var(--codeSnippetCopyLabel) 
[
  {
    "wfm_config_id": 4,
    "division_id": 2345,
    "metadata": {
      "report_capture_tz": "America/Chicago",
      "data_source": "NICE_ACD_DS1"
    }
  },
  {
    "wfm_config_id": 7,
    "division_id": 2,
    "metadata": {
      "report_capture_tz": "US/Central",
      "data_source": "NICE_ACD_DS"
    }
  }
]
Success Response 200 Success

Response Body Fields

Field

Type

description

wfm_config_id

 int Unique identifier for the External WFM Configuration.
division_id int The unique identifier for division within a tenant.
metadata JSON Object Configuration details with dynamic key-value pair.
     

Error Response

http

meaning

typical cause

 Response
401 Unauthorized Authentication failed Missing or invalid authentication token. Failed to authenticate
404 Not Found Resource not found No tenant found for the given BU number. Not found
409 Conflict Invalid operation. Business rule violation, such as duplicate configuration or other logical conflicts. Invalid operation while linking external WFM configuration with Tenants.
500 Internal Server Error Unexpected server error Unhandled exceptions or system failures. Internal server error while linking external wfm configurations

Sample Call
var(--codeSnippetCopyLabel) 
curl -X 'GET' \
  'http://wfm-config-na1.integrations.test.internal/wfm-integration/v1/externalWfmConfig/tenant/11e85283-2a5d-bda0-904d-0242ac110008/external-wfm-links' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJzZXJ2aWNlOjEyMzQ1Njc4OTAiLCJuYW1lIjoiSm9obiBEb2UiLCJhZG1pbiI6dHJ1ZSwiaWF0IjoxNz
                     YzNDY1MTc3LCJleHAiOjE3NjM0Njg3Nzd9.sN1AKKya0WK4s8iz1a32pLCvwpQhMld_RlxuoXBQ5Sc'

Notes

  • Authentication is required (Bearer token in the Authorization header).

API: For Linking BU with One or More External WFM Configuration

Description

 Links BU with one or more external wfm configurations, replaces prior linked configurations.
Authentication Required Authentication is required (Bearer token in the Authorization header).
URL

/wfm-integration/v1/externalWfmConfiguration/external-wfms-links

Method POST
Request Content-Type: application/json
Request Parameters

Field

Type

Description
busno int Business unit number
Request Body
var(--codeSnippetCopyLabel) 
[
  {
    "wfm_config_id": 1234,
    "division_id": 79,
    "metadata": {
      "report_capture_tz": "America/Chicago",
      "data_source": "NICE_ACD_DS1"
    }
  }
]
Request Body Fields

Field

Type

 Required

Description
wfm_config_id int Yes Unique identifier for the External WFM Configuration.
division_id int No The unique identifier for division within a tenant.
metadata JSON Object No Relation configuration details with dynamic key-value pairs.
Response Data
var(--codeSnippetCopyLabel) 
[
  {
    "wfm_config_id": 1234,
    "division_id": 79,
    "metadata": {
      "report_capture_tz": "America/Chicago",
      "data_source": "NICE_ACD_DS1"
    }
  }
]
Success Response 200 Success

Response Body Fields

Field

Type

description

wfm_config_id

 int Unique identifier for the External WFM Configuration.
division_id int The unique identifier for division within a tenant.
metadata JSON Object Configuration details with dynamic key-value pair.
     

Error Response

http

meaning

typical cause

 Response
400 Bad Request Invalid Request No tenant found for the given BU number. Bad Request
401 Unauthorized Authentication failed Missing or invalid authentication token. Failed to authenticate
404 Not Found Resource not found No WFM links found for the given Tenant Id. Not found
409 Conflict Invalid operation. Business rule violation, such as duplicate configuration or other logical conflicts. Invalid operation while linking external WFM configuration with BU.
500 Internal Server Error Unexpected server error Unhandled exceptions or system failures. Internal server error while linking external wfm configurations

Sample Call
var(--codeSnippetCopyLabel) 
curl -X 'POST' \
  'http://wfm-config-na1.integrations.test.internal/wfm-integration/v1/externalWfmConfig/bu/123/external-wfm-links' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJzZXJ2aWNlOjEyMzQ1Njc4OTAiLCJuYW1lIjoiSm
                     9obiBEb2UiLCJhZG1pbiI6dHJ1ZSwiaWF0IjoxNzYzNDYwODg5LCJleHAiOjE3NjM0NjQ0ODl9.P0SqraOtH1J5SFrsVwF
                     ER3l0lANCk7jif5HGFw5sGI8' \
  -H 'Content-Type: application/json' \
  -d '[
  {
    "wfm_config_id": 1234,
    "division_id": 79,
    "metadata": {
      "report_capture_tz": "America/Chicago",
      "data_source": "NICE_ACD_DS1"
    }
  }
]'

Notes

  • Authentication is required (Bearer token in the Authorization header).