HTTP actions
Call GET, POST, PUT, PATCH, or DELETE endpoints from inside a workflow.
REST Client component
REST Client for customer-owned automation.
Use REST Client for direct API calls, lightweight integrations, and customer-specific endpoints.
Call external HTTP APIs directly from a workflow when a full connector is not required.
REST Client
Component
REST ClientConfigure HTTP method, credentials, endpoint, parameters, headers, and payload.
CX
CXFabric Flow
Rules, credentials, validation, audit
SettingsInputs and options
LogsRun history and output
Next stepConnector, component, or approval
What this component unlocks
Use REST Client as a visible flow step.
The docs describe REST Client as a component for connecting with external systems or services using HTTP requests. Builders can toggle whether credentials are required, select stored credentials, manage credentials, choose GET, POST, PUT, PATCH, or DELETE, and define the endpoint URL. REST Client settings also support parameters, headers, form-data payloads, JSON payloads, hover tooltips, and execution results in the logs panel.
Credential-aware calls
Use stored credentials when API calls require authentication.
Request shaping
Send parameters, headers, form data, or JSON payloads to external systems.
Use cases
Where REST Client fits in automation.
These examples show how this component can become part of production workflows across customer-owned systems and environments.
Custom API action
Use REST Client as part of a governed CXFabric workflow that keeps configuration, credentials, logs, and handoffs visible.
- Collect the approved input
- Apply customer-specific rules
- Pass a clear result to the next step
Internal service call
Use REST Client as part of a governed CXFabric workflow that keeps configuration, credentials, logs, and handoffs visible.
- Collect the approved input
- Apply customer-specific rules
- Pass a clear result to the next step
Lightweight connector
Use REST Client as part of a governed CXFabric workflow that keeps configuration, credentials, logs, and handoffs visible.
- Collect the approved input
- Apply customer-specific rules
- Pass a clear result to the next step
Lookup endpoint
Use REST Client as part of a governed CXFabric workflow that keeps configuration, credentials, logs, and handoffs visible.
- Collect the approved input
- Apply customer-specific rules
- Pass a clear result to the next step
System update
Use REST Client as part of a governed CXFabric workflow that keeps configuration, credentials, logs, and handoffs visible.
- Collect the approved input
- Apply customer-specific rules
- Pass a clear result to the next step
Webhook-style handoff
Use REST Client as part of a governed CXFabric workflow that keeps configuration, credentials, logs, and handoffs visible.
- Collect the approved input
- Apply customer-specific rules
- Pass a clear result to the next step
Configuration surface
Practical options builders expect to use.
The exact fields can vary by deployment and product version, but each page gives customers a clear view of the component's intended role.
Add REST Client to canvas
Expose this behavior as a reusable, logged, credential-aware step inside a CXFabric flow.
Toggle credential requirement
Expose this behavior as a reusable, logged, credential-aware step inside a CXFabric flow.
Select credential
Expose this behavior as a reusable, logged, credential-aware step inside a CXFabric flow.
Choose HTTP method
Expose this behavior as a reusable, logged, credential-aware step inside a CXFabric flow.
Enter endpoint URL
Expose this behavior as a reusable, logged, credential-aware step inside a CXFabric flow.
Add parameters and headers
Expose this behavior as a reusable, logged, credential-aware step inside a CXFabric flow.
Choose form data or JSON payload
Expose this behavior as a reusable, logged, credential-aware step inside a CXFabric flow.
Execute and review logs
Expose this behavior as a reusable, logged, credential-aware step inside a CXFabric flow.
Implementation notes
Design the step with operations in mind.
Components should be easy for builders to configure and easy for operators to understand after the workflow is live.
Current CXFabric docs
Promote repeated REST Client patterns into connectors
Promote repeated REST Client patterns into connectors.
CXFabric approachMake the behavior explicit in the workflow so operators can see what happens before and after this component runs.
Validate error responses
Validate error responses.
CXFabric approachMake the behavior explicit in the workflow so operators can see what happens before and after this component runs.
Use credentials instead of hardcoded secrets
Use credentials instead of hardcoded secrets.
CXFabric approachMake the behavior explicit in the workflow so operators can see what happens before and after this component runs.
Workflow patterns
Reusable patterns for REST Client.
These are concept patterns that can be adapted to a customer's systems, policies, credentials, and deployment model.
REST Client in a customer intake flow
Start with an event, use REST Client, then route the result to CRM, ticketing, or a customer-owned system.
REST Client with approval and audit
Add validation, human approval, and logging around the component before downstream actions execute.
REST Client in a private runtime
Deploy the component inside a customer-owned environment with credentials and logs governed by the customer.
REST Client plus custom connector
Combine the component with packaged connectors or custom APIs when the process needs reusable system logic.
Component planning
Need REST Client inside a customer workflow?
We can scope the workflow, component configuration, credentials, deployment model, and handoff path before buildout begins.