Interface: WorkflowClientInterceptor

client.WorkflowClientInterceptor

Implement any of these methods to intercept WorkflowClient outbound calls

Implemented by

• OpenAIAgentsTraceClientInterceptor
• OpenTelemetryWorkflowClientInterceptor
• OpenTelemetryWorkflowClientInterceptor

Properties

cancel

• Optional cancel: (input: WorkflowCancelInput, next: OmitLastParam<(input: WorkflowCancelInput, next: OmitLastParam<...>) => Promise<IRequestCancelWorkflowExecutionResponse>>) => Promise<IRequestCancelWorkflowExecutionResponse>

Intercept a service call to requestCancelWorkflowExecution

Type declaration

▸ (input, next): Promise<IRequestCancelWorkflowExecutionResponse>

Parameters

Name	Type
input	WorkflowCancelInput
next	OmitLastParam<(input: WorkflowCancelInput, next: OmitLastParam<...>) => Promise<IRequestCancelWorkflowExecutionResponse>>

Returns

Promise<IRequestCancelWorkflowExecutionResponse>

---

describe

• Optional describe: (input: WorkflowDescribeInput, next: OmitLastParam<(input: WorkflowDescribeInput, next: OmitLastParam<...>) => Promise<IDescribeWorkflowExecutionResponse>>) => Promise<IDescribeWorkflowExecutionResponse>

Intercept a service call to describeWorkflowExecution

Type declaration

▸ (input, next): Promise<IDescribeWorkflowExecutionResponse>

Parameters

Name	Type
input	WorkflowDescribeInput
next	OmitLastParam<(input: WorkflowDescribeInput, next: OmitLastParam<...>) => Promise<IDescribeWorkflowExecutionResponse>>

Returns

Promise<IDescribeWorkflowExecutionResponse>

---

query

• Optional query: (input: WorkflowQueryInput, next: OmitLastParam<(input: WorkflowQueryInput, next: OmitLastParam<...>) => Promise<unknown>>) => Promise<unknown>

Intercept a service call to queryWorkflow

Type declaration

▸ (input, next): Promise<unknown>

Parameters

Name	Type
input	WorkflowQueryInput
next	OmitLastParam<(input: WorkflowQueryInput, next: OmitLastParam<...>) => Promise<unknown>>

Returns

Promise<unknown>

---

signal

• Optional signal: (input: WorkflowSignalInput, next: OmitLastParam<(input: WorkflowSignalInput, next: OmitLastParam<...>) => Promise<void>>) => Promise<void>

Intercept a service call to signalWorkflowExecution

If you implement this method, signalWithStart most likely needs to be implemented too

Type declaration

▸ (input, next): Promise<void>

Parameters

Name	Type
input	WorkflowSignalInput
next	OmitLastParam<(input: WorkflowSignalInput, next: OmitLastParam<...>) => Promise<void>>

Returns

Promise<void>

---

signalWithStart

• Optional signalWithStart: (input: WorkflowSignalWithStartInput, next: OmitLastParam<(input: WorkflowSignalWithStartInput, next: OmitLastParam<...>) => Promise<string>>) => Promise<string>

Intercept a service call to signalWithStartWorkflowExecution

Type declaration

▸ (input, next): Promise<string>

Parameters

Name	Type
input	WorkflowSignalWithStartInput
next	OmitLastParam<(input: WorkflowSignalWithStartInput, next: OmitLastParam<...>) => Promise<string>>

Returns

Promise<string>

---

start

• Optional start: (input: WorkflowStartInput, next: OmitLastParam<(input: WorkflowStartInput, next: OmitLastParam<...>) => Promise<string>>) => Promise<string>

Intercept a service call to startWorkflowExecution

If you implement this method, signalWithStart most likely needs to be implemented too

Deprecated

in favour of startWithDetails

Type declaration

▸ (input, next): Promise<string>

Parameters

Name	Type
input	WorkflowStartInput
next	OmitLastParam<(input: WorkflowStartInput, next: OmitLastParam<...>) => Promise<string>>

Returns

Promise<string>

---

startUpdate

• Optional startUpdate: (input: WorkflowStartUpdateInput, next: OmitLastParam<(input: WorkflowStartUpdateInput, next: OmitLastParam<...>) => Promise<WorkflowStartUpdateOutput>>) => Promise<WorkflowStartUpdateOutput>

Intercept a service call to updateWorkflowExecution

Type declaration

▸ (input, next): Promise<WorkflowStartUpdateOutput>

Parameters

Name	Type
input	WorkflowStartUpdateInput
next	OmitLastParam<(input: WorkflowStartUpdateInput, next: OmitLastParam<...>) => Promise<WorkflowStartUpdateOutput>>

Returns

Promise<WorkflowStartUpdateOutput>

---

startUpdateWithStart

• Optional startUpdateWithStart: (input: WorkflowStartUpdateWithStartInput, next: OmitLastParam<(input: WorkflowStartUpdateWithStartInput, next: OmitLastParam<...>) => Promise<WorkflowStartUpdateWithStartOutput>>) => Promise<WorkflowStartUpdateWithStartOutput>

Intercept a service call to startUpdateWithStart

Type declaration

▸ (input, next): Promise<WorkflowStartUpdateWithStartOutput>

Parameters

Name	Type
input	WorkflowStartUpdateWithStartInput
next	OmitLastParam<(input: WorkflowStartUpdateWithStartInput, next: OmitLastParam<...>) => Promise<WorkflowStartUpdateWithStartOutput>>

Returns

Promise<WorkflowStartUpdateWithStartOutput>

---

startWithDetails

• Optional startWithDetails: (input: WorkflowStartInput, next: OmitLastParam<(input: WorkflowStartInput, next: OmitLastParam<...>) => Promise<WorkflowStartOutput>>) => Promise<WorkflowStartOutput>

Intercept a service call to startWorkflowExecution

This method returns start details via WorkflowStartOutput.

If you implement this method, signalWithStart most likely needs to be implemented too

Type declaration

▸ (input, next): Promise<WorkflowStartOutput>

Parameters

Name	Type
input	WorkflowStartInput
next	OmitLastParam<(input: WorkflowStartInput, next: OmitLastParam<...>) => Promise<WorkflowStartOutput>>

Returns

Promise<WorkflowStartOutput>

---

terminate

• Optional terminate: (input: WorkflowTerminateInput, next: OmitLastParam<(input: WorkflowTerminateInput, next: OmitLastParam<...>) => Promise<ITerminateWorkflowExecutionResponse>>) => Promise<ITerminateWorkflowExecutionResponse>

Intercept a service call to terminateWorkflowExecution

Type declaration

▸ (input, next): Promise<ITerminateWorkflowExecutionResponse>

Parameters

Name	Type
input	WorkflowTerminateInput
next	OmitLastParam<(input: WorkflowTerminateInput, next: OmitLastParam<...>) => Promise<ITerminateWorkflowExecutionResponse>>

Returns

Promise<ITerminateWorkflowExecutionResponse>