Workato Skill connector - Return response action

The Return response action ends a skill recipe and sends a result to the calling agent. Include this action as the last step of every skill recipe. Any steps that follow it don't run because this action terminates the job. The calling agent receives no structured response and the skill call fails if a skill recipe doesn't include this action.

PREREQUISITES

You must configure the Start workflow trigger before configuring this action. The trigger defines the fields available in the Result field.

Input

Input fieldDescription
ResultEnter the values to return to the calling agent. The fields in this object are defined in the What should be returned to the agent after this skill is run? field of the Start workflow trigger.

Output

Output fieldDescription
ResultEchoes the values returned to the agent. Use this output if a downstream step needs to log or post-process what the skill sent back.

Stream large results

The Return response action has a maximum response size of 250 KB. Results that exceed 250 KB cause the action to fail with a Result is too big error. Reduce the result size to stay under the limit.

Alternatively, pass the content as a streamable datapill, such as a File contents, into the result field. Workato automatically streams the content to the calling agent in chunks. Refer to File streaming for more information about streamable datapills.

Binary content

Result fields don't support binary file content. To work around this limitation, upload the file earlier in the recipe to a file storage location your agent can access, such as Workato file storage, Amazon S3, or Google Drive. Then return the file URL or ID as a string field. The agent retrieves the file using that reference. This pattern keeps the result payload small and avoids the 250 KB result size limit.

Last updated: