Calling an external API from a Webex Contact Center flow
Webex Contact Center
Verified 2026-09-30 · 48 sources · tier 1–4
For Flow developers and Contact Center administrators configuring HTTP lookups in Flow Designer and Control Hub.
The Webex Contact Center HTTP connector lets flow developers invoke Webex Contact Center APIs directly from Flow Designer 47. Flows retrieve data from external systems using GET and transmit data using PUT, POST, or DELETE 42.
Before you start
- Ensure you hold the Full Administrator, External Full Administrator, or Contact Center Service Administrator role in Control Hub before attempting to create connectors 8.
- Confirm that your organization has not reached its connector limits: an organization can have at most 5 Webex Contact Center connectors 45 and at most 10 custom connectors 11.
- If you plan to connect to a third-party API via a custom connector, confirm that the target domain is served over HTTPS, as the Resource Domain URL requires an https:// prefix 13.
What changes by situation
Pick your answers to see only your path. Nothing is sent anywhere until you make a plan.
Two questions. One permanent page you can send to your manager.
Step 1 Navigate to connectors in Control Hub
Do
Open Control Hub and navigate to Contact Center, Integrations, Connectors 7.
Verify
Suggested check: Verify that the Connectors page opens and that your administrative account has permission to view and add connectors.
Rollback
Suggested rollback: No configuration was created; close the browser tab.
Step 2 Configure authentication credentials
Webex Contact Center connector for internal Contact Center APIs
Do
Add a Webex Contact Center connector by providing a unique Name, selecting an access level of Read-Only or Read-Write, and confirming authorization to read, write, modify, and delete Contact Center data 44. Cisco recommends selecting Read-Only if the flow only performs GET calls, and reserving Read-Write for operations that create or update data 28. This connector handles authentication natively without requiring a separate token server or integration 46.
Verify
Confirm that the connector appears in the connectors list, noting that its ID cannot be modified after creation 6.
Rollback
Suggested rollback: Remove the connector from every flow before attempting deletion. Deleting a Webex Contact Center HTTP connector removes its functions from workflows that use it 16, and deactivating it halts call routing for any flows that rely on it 14.
Custom connector for third-party APIs using Basic Auth or OAuth 2.0
Do
Add a custom connector with a unique Name and enter a Resource Domain URL beginning with https:// 13. Select an Authentication Type: Basic Authentication (the default) or OAuth 2.0 with Client credentials - certificate, Client credentials - client secret, or Password Grant 9. For Basic Authentication, provide a Username, a Password, and a Validation URL 10. For OAuth 2.0, enter the Token URL and Scope, accompanied by the credentials required by the grant type (Client ID and Client Secret, Username and Password, or public and private key certificates) 12.
Verify
Suggested check: Save the connector and confirm that it passes validation URL verification and appears in the connectors table.
Rollback
Suggested rollback: Delete the custom connector from Control Hub after detaching it from any flows.
Open endpoint or manual Authorization header without a connector
Do
To connect without a connector, prepare an Authorization header whose value is Basic followed by the Base64 encoding of username:password 30. WarmTransfer's reading of the sources is that storing a hand-built Basic Authorization header embeds a reversible credential inside the flow definition rather than in a Control Hub connector, making it recoverable by anyone who can edit or export the flow 31.
Verify
Suggested check: Verify that your full target URL and encoded header values are documented and ready to input into Flow Designer.
Rollback
Suggested rollback: No connector was created in Control Hub; discard any prepared header strings.
Step 3 Add and place the HTTP Request activity
Webex Contact Center connector for internal Contact Center APIs
Do
Add the HTTP Request activity to the flow canvas, ensuring it is not placed immediately after a Queue Contact activity because it may not retrieve the required data in that position 2. Turn on Use Authenticated Endpoint and select your Webex Contact Center connector from the Connector drop-down 38. In the Request Path field, enter only the API path rather than the full URL, as the connector supplies the base domain 36.
Verify
Suggested check: Verify that the activity configuration panel displays the selected connector and relative path without validation errors.
Rollback
Suggested rollback: Remove the HTTP Request activity from the flow canvas.
Custom connector for third-party APIs using Basic Auth or OAuth 2.0
Do
Place the HTTP Request activity on the flow canvas, ensuring it is not placed immediately after a Queue Contact activity 2. Turn on Use Authenticated Endpoint and select your custom connector from the Connector drop-down 38. Enter only the relative path in the Request Path field, as the connector supplies the base domain 36.
Verify
Suggested check: Verify that the activity displays the custom connector and relative path.
Rollback
Suggested rollback: Remove the HTTP Request activity from the flow canvas.
Open endpoint or manual Authorization header without a connector
Do
Place the HTTP Request activity on the flow canvas, ensuring it is not positioned immediately following a Queue Contact activity 2. Ensure the Use Authenticated Endpoint toggle is turned off 39. Enter the complete request URL into the activity and configure the Authorization header with the Base64 credential string if required 30.
Verify
Suggested check: Verify that the full URL and header key-value pairs are populated in the activity properties.
Rollback
Suggested rollback: Remove the HTTP Request activity from the canvas.
Step 4 Configure HTTP methods and request content
Do
Configure the HTTP Request Method to GET for retrieval, or to PUT, POST, or DELETE to send data 42. For Webex Contact Center API calls, configure the Method, optional Query Parameters, and set Content Type to Application/JSON 48.
Verify
Suggested check: Confirm that the selected method and content-type match the target endpoint's API specifications.
Rollback
Suggested rollback: Revert method and payload parameters to their default empty states.
Step 5 Extract response data into variables
In the flow using JSONPath expressions in Parse Settings
Do
Open Parse Settings on the HTTP Request activity to parse the response into flow variables using JSON Path expressions to identify specific fields 34. Start each JSONPath expression with the root identifier $ 26. Use dot notation for member names, wildcards, array index brackets, or filter selectors (?) to isolate the target elements 27. The result of a JSONPath query under RFC 9535 is a nodelist, which can be empty when nothing matches 25.
Verify
Suggested check: Verify that each defined variable target in Parse Settings contains a complete JSONPath syntax string starting with $.
Rollback
Suggested rollback: Clear all configured rows from Parse Settings.
In an external mechanism outside flow Parse Settings
Do
Verify
Suggested check: Verify that the HTTP Request activity outputs the complete response payload.
Rollback
Suggested rollback: Re-enter JSONPath mappings into Parse Settings if external extraction is abandoned.
Step 6 Route success and error branches
Do
Place a Case activity immediately following the HTTP Request activity to check the HTTP status code for 200 OK 5. Configure the flow to handle rate limiting, process HTTP 429 responses gracefully, and use Case activities to handle documented API error codes 23. Connect an Undefined Error path to catch system errors 40. WarmTransfer's reading of the sources is that because JSONPath returns an empty nodelist when nothing matches and Cisco does not document what is written to the variable, lookup flows should evaluate whether the parsed variable is empty before executing routing logic 17. Ensure sensitive response data from API calls is not logged 4.
Verify
Suggested check: Check that every outcome branch on the Case activity and the Undefined Error edge connect to valid downstream steps.
Rollback
Suggested rollback: Disconnect the routing edges leading from the Case activity.
Step 7 Validate and publish the flow
Do
Run the validation tool in Flow Designer and correct all identified errors, as publishing remains disabled until all errors are resolved 41. Publish the flow and apply a version label such as Dev or Test to support blue-green deployment rather than applying Live immediately 43. Flow Designer has no version control feature; the version number counts how many times the flow has been published 29.
Verify
Suggested check: Confirm that the flow validation completes without errors and the publish history increments the version count.
Rollback
Suggested rollback: Revert by switching the version label back to the previously published version 43.
Applicability
Applies to: Cisco Webex Contact Center and IETF JSONPath. Deployments: multi-tenant. Sources checked 2026-09-30.
What remains uncertain
The HTTP Request activity's request timeout period, default retry count, and retry backoff behavior are not covered by the sources below. Response body size limits and whether Flow Designer strictly implements RFC 9535 syntax across all JSONPath filter expressions are not covered by the sources below.
See also
Configures
- Webex contact center — No Webex Contact Center topic exists in the corpus yet; link when created.
Related to
- Getting started with the Webex Contact Center APIs — Sibling guide on Webex Contact Center API integration; the Webex Contact Center connector overlaps.
- Setting up screen pops and CAD variables in Webex Contact Center — Data-dip results are commonly passed to the agent desktop.
Referenced by
- Setting up screen pops and CAD variables in Webex Contact Center — Data dips that fill CAD variables before the pop are covered by the HTTP Request guide.
- Webex contact center — Inbound relationship already recorded: wxcc-http-request-setup configures this topic (HTTP Request activity in Flow Designer).
Sources
- 1The Flow Designer HTTP Request activity fetches information from an external data source such as a CRM using standard HTTP protocols.Build and manage flows with Flow Designer · HTTP Request activity section (seen via search-engine index excerpt only) · Checked 2026-09-30
- 2When an HTTP Request activity is placed immediately after the Queue Contact activity, the HTTP Request may not retrieve the required data.Build and manage flows with Flow Designer · note sentence returned verbatim by WebFetch · Checked 2026-09-30
- 3The HTTP Request activity supports Basic Auth and OAuth 2.0 attributes for authenticated endpoints.Build and manage flows with Flow Designer · HTTP Request activity section (search-engine index excerpt) · Checked 2026-09-30
- 4Cisco recommends not logging sensitive response data from API calls made in flows.Using the New HTTP Connector for Webex Contact Center APIs · best practices section · Checked 2026-09-30
- 5Cisco's verification step is a Case activity placed right after the HTTP Request activity that checks the status code for 200 OK.Configure HTTP Request on Call Flows with Authorization Type as Basic on WebEx Contact Center · Verify · Checked 2026-09-30
- 6The ID of a Webex Contact Center HTTP connector cannot be modified after creation.Create Webex Contact Center HTTP connector · Create the connector procedure, note · Checked 2026-09-30
- 8Creating a Webex Contact Center HTTP connector requires the Full Administrator, External Full Administrator, or Contact Center Service Administrator role.Create Webex Contact Center HTTP connector · Before you begin · Checked 2026-09-30
- 9A custom connector supports Basic Authentication (the default) and OAuth 2.0 with the grant types Client credentials - certificate, Client credentials - client secret, and Password Grant.Configure custom connector for Webex Contact Center · Configure custom connector procedure, Authentication Type · Checked 2026-09-30
- 10For Basic Authentication, a custom connector takes a Username, a Password and a Validation URL used to validate the username and password.Configure custom connector for Webex Contact Center · Configure custom connector procedure, Basic Authentication fields · Checked 2026-09-30
- 11An organization can have at most 10 custom connectors.System limits in Webex Contact Center · Table 1, Number of Connectors row · Checked 2026-09-30
- 12For OAuth 2.0, a custom connector takes a Token URL for the authorization server and a Scope, plus Client ID and Client Secret (client secret and password grants), Username and Password (password grant), or a public and private key certificate (certificate grant).Configure custom connector for Webex Contact Center · Configure custom connector procedure, OAuth 2.0 fields · Checked 2026-09-30
- 13A custom connector's Resource Domain URL must be entered with an https:// prefix.Configure custom connector for Webex Contact Center · Configure custom connector procedure, Resource Domain URL · Checked 2026-09-30
- 14Deactivating a Webex Contact Center HTTP connector halts call routing for any flows that use it.Create Webex Contact Center HTTP connector · Manage the connector, deactivate note · Checked 2026-09-30
- 15Flow debugging can decrypt logs selectively, based on administrator privileges set in user profiles, with flow-level and activity-level decryption settings and extra search filters.What's new for administrators in Webex Contact Center · entry on enhanced Flow Debugging (search-engine index excerpt; entry date not seen) · Checked 2026-09-30
- 16Deleting a Webex Contact Center HTTP connector removes its functions from the workflows that use it.Create Webex Contact Center HTTP connector · Manage the connector, delete note · Checked 2026-09-30
- 17Because a JSONPath that matches nothing returns an empty result, and Cisco does not document what Flow Designer writes to the output variable in that case, a lookup flow should test the parsed variable for empty before routing on it.inferredRFC 9535: JSONPath: Query Expressions for JSON · Section 2.1.2, applied to Flow Designer Parse Settings · Checked 2026-09-30
- 18Flow Designer functions let you write custom code inline in a code editor, in JavaScript or Python, and reuse it across flows.Build and manage flows with Flow Designer · Create and manage functions (search-engine index excerpt; heading confirmed by WebFetch) · Checked 2026-09-30
- 19An organization supports at most 200 functions, and each function gets at most 128 MB of memory.Build and manage flows with Flow Designer · Create and manage functions, limitations (search-engine index excerpt) · Checked 2026-09-30
- 20Values returned by a Function activity can be parsed and set into flow variables, and flow logic can branch on the activity's output variables and status or error codes.What's new for administrators in Webex Contact Center · entry introducing the Function activity (search-engine index excerpt; entry date not seen) · Checked 2026-09-30
- 21Function code can be tested with sample values, showing outputs and errors, before the flow is published.Build and manage flows with Flow Designer · Create a function (search-engine index excerpt) · Checked 2026-09-30
- 22The HTTP Request activity supports a GraphQL content type for APIs that accept GraphQL.What's new for administrators in Webex Contact Center · entry on HTTP activity GraphQL content type (search-engine index excerpt; entry date not seen) · Checked 2026-09-30
- 23Cisco recommends that flows calling Contact Center APIs allow for rate limiting, handle HTTP 429 responses gracefully, and handle documented API error codes with Case activities.Using the New HTTP Connector for Webex Contact Center APIs · best practices section · Checked 2026-09-30
- 24Flow developers can create custom flow variables of type JSON and use them in the HTTP Request, Parse and Set Variable activities, including storing data extracted with a JSON path filter expression.Build and manage flows with Flow Designer · Flow variables, JSON variable type (search-engine index excerpt) · Checked 2026-09-30
- 25The result of a JSONPath query under RFC 9535 is a nodelist, which can be empty when nothing matches.RFC 9535: JSONPath: Query Expressions for JSON · Section 2.1.2 · Checked 2026-09-30
- 26In JSONPath (RFC 9535), a query starts with the root identifier $, which stands for the root node of the JSON value being queried.RFC 9535: JSONPath: Query Expressions for JSON · Section 2.2.2 · Checked 2026-09-30
- 27RFC 9535 defines name (dot-notation), wildcard, index and filter (?) selectors for picking members and array elements out of a JSON value.RFC 9535: JSONPath: Query Expressions for JSON · Sections 2.3.1, 2.3.2, 2.3.3, 2.3.5 · Checked 2026-09-30
- 28Cisco recommends Read-Only access for a Webex Contact Center connector used only for GET calls, keeping Read-Write for calls that create or update data.Using the New HTTP Connector for Webex Contact Center APIs · best practices section · Checked 2026-09-30
- 29Flow Designer has no version control feature; the flow version number counts how many times the flow has been published.Build and manage flows with Flow Designer · flow version description (sentence returned verbatim by WebFetch) · Checked 2026-09-30
- 30Without a connector, turn off Use Authenticated Endpoint, enter the complete request URL, and add an Authorization header whose value is Basic followed by the Base64 encoding of username:password.Configure HTTP Request on Call Flows with Authorization Type as Basic on WebEx Contact Center · Configure, method without connector · Checked 2026-09-30
- 31An open request that carries a hand-built Basic Authorization header stores a reversible credential inside the flow definition rather than in a Control Hub connector, so anyone who can edit or export the flow can recover it.inferredConfigure HTTP Request on Call Flows with Authorization Type as Basic on WebEx Contact Center · Configure, method without connector (header value is plain Base64) · Checked 2026-09-30
- 32The HTTP Request activity exposes an httpResponseBody output variable that returns the response body of the request.Build and manage flows with Flow Designer · HTTP Request activity, output variables (search-engine index excerpt) · Checked 2026-09-30
- 33The HTTP Request activity exposes an httpStatusCode output variable that returns the HTTP status code of the request.Build and manage flows with Flow Designer · HTTP Request activity, output variables (search-engine index excerpt) · Checked 2026-09-30
- 34In the HTTP Request activity's Parse Settings, the response can be parsed into flow variables using a JSON Path expression to find specific fields.Create Webex Contact Center HTTP connector · Use the connector in Flow Designer; Parse Settings bullet · Checked 2026-09-30
- 35Path Expression is required on each parsed variable row in Parse Settings; leaving it blank fails validation and the flow cannot be published.Build and manage flows with Flow Designer · HTTP Request activity, Parse Settings (search-engine index excerpt) · Checked 2026-09-30
- 36With a connector selected, the Request Path holds only the API path, not the full URL; the connector supplies the base domain.Using the New HTTP Connector for Webex Contact Center APIs · HTTP Request activity configuration · Checked 2026-09-30
- 37The Set Variable activity can set up to 10 variables or expressions in a single operation.What's new for administrators in Webex Contact Center · entry on enhanced Set Variable activity (search-engine index excerpt; entry date not seen) · Checked 2026-09-30
- 38To use a connector, turn on Use Authenticated Endpoint in the HTTP Request activity and pick the connector from the Connector drop-down.Create Webex Contact Center HTTP connector · Use the connector in Flow Designer · Checked 2026-09-30
- 39The Use Authenticated Endpoint toggle in the HTTP Request activity can be turned off.Configure custom connector for Webex Contact Center · use in Flow Designer note · Checked 2026-09-30
- 40An error-handling path named Undefined Error can be configured to handle system errors.Build and manage flows with Flow Designer · activity error handling description (sentence returned verbatim by WebFetch) · Checked 2026-09-30
- 41A flow must be validated and its errors fixed before it can be published; publishing stays disabled until errors are resolved.Build and manage flows with Flow Designer · Validate and publish a flow (Validation toggle in footer pane) · Checked 2026-09-30
- 42The HTTP activity retrieves data from external systems with GET and sends data to them with the other supported verbs PUT, POST and DELETE.Design Delightful Customer Experiences with Webex Contact Center Flow Designer · HTTP Activity section · Checked 2026-09-30
- 43Flow Designer lets you apply version labels such as Dev, Test and Live to a flow to support blue-green style deployment.Rapidly Adapt Your CX Workflows With Webex Contact Center Flow Designer · Flow Versioning section · Checked 2026-09-30
- 44Creating a Webex Contact Center HTTP connector requires a unique Name, an access level of Read-Only or Read-Write, and confirming authorization to read, write, modify and delete Contact Center data.Create Webex Contact Center HTTP connector · Create the connector procedure · Checked 2026-09-30
- 45An organization can have at most 5 Webex Contact Center connectors.System limits in Webex Contact Center · Table 1, Number of Connectors row · Checked 2026-09-30
- 46The Webex Contact Center HTTP connector handles authentication natively, removing the need for a separate integration and token server to call Contact Center APIs from a flow.Using the New HTTP Connector for Webex Contact Center APIs · introduction · Checked 2026-09-30
- 47The Webex Contact Center HTTP connector lets flow developers invoke Webex Contact Center APIs from Flow Designer.Create Webex Contact Center HTTP connector · introduction · Checked 2026-09-30
- 48For a Contact Center API call, the HTTP Request activity is configured with Connector, Request Path, Method (the REST verb), optional Query Parameters, and Content Type set to Application/JSON.Create Webex Contact Center HTTP connector · Use the connector in Flow Designer · Checked 2026-09-30
Documents
RFC 9535: JSONPath: Query Expressions for JSON
Build and manage flows with Flow Designer
Configure custom connector for Webex Contact Center
Configure HTTP Request on Call Flows with Authorization Type as Basic on WebEx Contact Center
Create Webex Contact Center HTTP connector
System limits in Webex Contact Center
Using the New HTTP Connector for Webex Contact Center APIs
What's new for administrators in Webex Contact Center
Design Delightful Customer Experiences with Webex Contact Center Flow Designer
Rapidly Adapt Your CX Workflows With Webex Contact Center Flow Designer
Cite this page
APA
WarmTransfer. (2026, September 30). Calling an external API from a Webex Contact Center flow. WarmTransfer. https://warmtransfer.net/guides/wxcc-http-request-setup
BibTeX
@misc{warmtransfer-wxcc-http-request-setup,
title = {Calling an external API from a Webex Contact Center flow},
author = {{WarmTransfer}},
year = {2026},
url = {https://warmtransfer.net/guides/wxcc-http-request-setup},
note = {Verified 2026-09-30}
}