Skill

workato-connector-sdk-data-formats

This skill should be used when the user asks about "request_format", "response_format", "xml format workato", "json format workato", "multipart form", "form-url-encoded", "parse xml", "build xml", or needs to handle different data formats in a Workato connector.

From workato-connector-sdk

Install

Run in your terminal

npx claudepluginhub grailautomation/claude-plugins --plugin workato-connector-sdk

Tool Access

This skill uses the workspace's default tool permissions.

Supporting Assets

View in Repository

references/guides__data-formats.md

references/guides__data-formats__form-url-encoded.md

references/guides__data-formats__json-format.md

references/guides__data-formats__request_format_multipart_form.md

references/guides__data-formats__xml-format.md

Skill Content

Workato SDK Data Formats

Guide for handling different request and response formats in Workato custom connectors.

Overview

Workato connectors support multiple data formats:

JSON (default) - Most common API format
XML - SOAP and legacy APIs
Form URL-encoded - OAuth and simple forms
Multipart form - File uploads

Request Formats

JSON (Default)

JSON is the default format. No special configuration needed:

execute: lambda do |connection, input|
  post('/api/records')
    .payload(
      name: input['name'],
      email: input['email']
    )
  # Automatically sends Content-Type: application/json
end

Form URL-Encoded

For OAuth token exchanges and simple form submissions:

execute: lambda do |connection, input|
  post('/oauth/token')
    .payload(
      grant_type: 'authorization_code',
      code: input['code'],
      redirect_uri: input['redirect_uri']
    )
    .request_format_www_form_urlencoded
  # Sends Content-Type: application/x-www-form-urlencoded
end

Multipart Form

For file uploads:

execute: lambda do |connection, input|
  post('/api/files')
    .payload(
      file: input['file_content'],
      filename: input['filename'],
      description: input['description']
    )
    .request_format_multipart_form
  # Sends Content-Type: multipart/form-data
end

XML

For SOAP and XML-based APIs:

execute: lambda do |connection, input|
  post('/api/records')
    .payload(
      'Record' => {
        '@xmlns' => 'http://example.com/schema',
        'Name' => input['name'],
        'Email' => input['email']
      }
    )
    .request_format_xml
  # Sends Content-Type: application/xml
end

Response Formats

JSON Response (Default)

Responses are automatically parsed as JSON:

execute: lambda do |connection, input|
  response = get('/api/records/123')
  # response is already a Hash
  { id: response['id'], name: response['name'] }
end

XML Response

Parse XML responses:

execute: lambda do |connection, input|
  response = get('/api/records/123')
    .response_format_xml

  # Access XML elements
  {
    id: response.dig('Record', 'Id'),
    name: response.dig('Record', 'Name')
  }
end

Raw Response

For binary data or custom parsing:

execute: lambda do |connection, input|
  content = get("/api/files/#{input['id']}/download")
    .response_format_raw

  { file_content: content }
end

XML Specifics

Building XML Payloads

Use hashes with special keys:

payload = {
  'Envelope' => {
    '@xmlns:soap' => 'http://schemas.xmlsoap.org/soap/envelope/',
    'Body' => {
      'CreateRecord' => {
        '@xmlns' => 'http://example.com/api',
        'Name' => 'Test',
        'Items' => {
          'Item' => [
            { 'Value' => 'A' },
            { 'Value' => 'B' }
          ]
        }
      }
    }
  }
}

Produces:

<Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <Body>
    <CreateRecord xmlns="http://example.com/api">
      <Name>Test</Name>
      <Items>
        <Item><Value>A</Value></Item>
        <Item><Value>B</Value></Item>
      </Items>
    </CreateRecord>
  </Body>
</Envelope>

XML Attributes

Prefix attribute keys with @:

{
  'Record' => {
    '@id' => '123',           # Attribute
    '@type' => 'contact',     # Attribute
    'Name' => 'John'          # Element
  }
}

Produces:

<Record id="123" type="contact">
  <Name>John</Name>
</Record>

XML Namespaces

Define namespaces with @xmlns:

{
  'soap:Envelope' => {
    '@xmlns:soap' => 'http://schemas.xmlsoap.org/soap/envelope/',
    '@xmlns:api' => 'http://example.com/api',
    'soap:Body' => {
      'api:GetRecord' => {
        'api:Id' => '123'
      }
    }
  }
}

Parsing XML Responses

Navigate with dig:

response = get('/api/record')
  .response_format_xml

# Access nested elements
name = response.dig('Envelope', 'Body', 'GetRecordResponse', 'Record', 'Name')

# Access attributes
id = response.dig('Envelope', 'Body', 'GetRecordResponse', 'Record', '@id')

# Handle arrays
items = response.dig('Envelope', 'Body', 'GetRecordResponse', 'Items', 'Item')
items = [items] unless items.is_a?(Array)  # Ensure array

Multipart Form Details

File Upload with Metadata

execute: lambda do |connection, input|
  post('/api/upload')
    .payload(
      file: [
        input['file_content'],
        'application/octet-stream',     # Content type
        input['filename']               # Filename
      ],
      metadata: input['metadata'].to_json
    )
    .request_format_multipart_form
end

Multiple Files

execute: lambda do |connection, input|
  files = input['files'].map do |file|
    ['files[]', [file['content'], file['content_type'], file['name']]]
  end

  post('/api/upload')
    .payload(Hash[files])
    .request_format_multipart_form
end

Content Type Headers

Override content type when needed:

execute: lambda do |connection, input|
  post('/api/data')
    .payload(input['raw_data'])
    .headers('Content-Type' => 'text/plain')
end

Combining Formats

Different request and response formats:

execute: lambda do |connection, input|
  # Send form-encoded, receive JSON
  response = post('/oauth/token')
    .payload(grant_type: 'client_credentials')
    .request_format_www_form_urlencoded
    # Response is JSON by default

  { access_token: response['access_token'] }
end

Reference Files

For detailed documentation:

references/guides__data-formats.md - Data formats overview
references/guides__data-formats__json-format.md - JSON format details
references/guides__data-formats__xml-format.md - XML format details
references/guides__data-formats__form-url-encoded.md - Form URL-encoded
references/guides__data-formats__request_format_multipart_form.md - Multipart form uploads

Similar Skills

context7-mcp

Fetches up-to-date documentation from Context7 for libraries and frameworks like React, Next.js, Prisma. Use for setup questions, API references, and code examples.

51.4k

find-docs

Retrieves current documentation, API references, and code examples for libraries, frameworks, SDKs, CLIs, and services via Context7 CLI. Ideal for API syntax, configs, migrations, and setup queries.

50.8k

context7-cli

3 files

Uses ctx7 CLI to fetch current library docs, manage AI coding skills (install/search/generate), and configure Context7 MCP for AI editors.

50.8k

Stats

Parent Repo Stars0

Parent Repo Forks0

Last CommitMar 26, 2026

Actions

View Source View Plugin View on GitHub View README

Workato SDK Data Formats

Guide for handling different request and response formats in Workato custom connectors.

Overview

Workato connectors support multiple data formats:

JSON (default) - Most common API format
XML - SOAP and legacy APIs
Form URL-encoded - OAuth and simple forms
Multipart form - File uploads

Request Formats

JSON (Default)

JSON is the default format. No special configuration needed:

execute: lambda do |connection, input|
  post('/api/records')
    .payload(
      name: input['name'],
      email: input['email']
    )
  # Automatically sends Content-Type: application/json
end

Form URL-Encoded

For OAuth token exchanges and simple form submissions:

execute: lambda do |connection, input|
  post('/oauth/token')
    .payload(
      grant_type: 'authorization_code',
      code: input['code'],
      redirect_uri: input['redirect_uri']
    )
    .request_format_www_form_urlencoded
  # Sends Content-Type: application/x-www-form-urlencoded
end

Multipart Form

For file uploads:

execute: lambda do |connection, input|
  post('/api/files')
    .payload(
      file: input['file_content'],
      filename: input['filename'],
      description: input['description']
    )
    .request_format_multipart_form
  # Sends Content-Type: multipart/form-data
end

XML

For SOAP and XML-based APIs:

execute: lambda do |connection, input|
  post('/api/records')
    .payload(
      'Record' => {
        '@xmlns' => 'http://example.com/schema',
        'Name' => input['name'],
        'Email' => input['email']
      }
    )
    .request_format_xml
  # Sends Content-Type: application/xml
end

Response Formats

JSON Response (Default)

Responses are automatically parsed as JSON:

execute: lambda do |connection, input|
  response = get('/api/records/123')
  # response is already a Hash
  { id: response['id'], name: response['name'] }
end

XML Response

Parse XML responses:

execute: lambda do |connection, input|
  response = get('/api/records/123')
    .response_format_xml

  # Access XML elements
  {
    id: response.dig('Record', 'Id'),
    name: response.dig('Record', 'Name')
  }
end

Raw Response

For binary data or custom parsing:

execute: lambda do |connection, input|
  content = get("/api/files/#{input['id']}/download")
    .response_format_raw

  { file_content: content }
end

XML Specifics

Building XML Payloads

Use hashes with special keys:

payload = {
  'Envelope' => {
    '@xmlns:soap' => 'http://schemas.xmlsoap.org/soap/envelope/',
    'Body' => {
      'CreateRecord' => {
        '@xmlns' => 'http://example.com/api',
        'Name' => 'Test',
        'Items' => {
          'Item' => [
            { 'Value' => 'A' },
            { 'Value' => 'B' }
          ]
        }
      }
    }
  }
}

Produces:

<Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <Body>
    <CreateRecord xmlns="http://example.com/api">
      <Name>Test</Name>
      <Items>
        <Item><Value>A</Value></Item>
        <Item><Value>B</Value></Item>
      </Items>
    </CreateRecord>
  </Body>
</Envelope>

XML Attributes

Prefix attribute keys with @:

{
  'Record' => {
    '@id' => '123',           # Attribute
    '@type' => 'contact',     # Attribute
    'Name' => 'John'          # Element
  }
}

Produces:

<Record id="123" type="contact">
  <Name>John</Name>
</Record>

XML Namespaces

Define namespaces with @xmlns:

{
  'soap:Envelope' => {
    '@xmlns:soap' => 'http://schemas.xmlsoap.org/soap/envelope/',
    '@xmlns:api' => 'http://example.com/api',
    'soap:Body' => {
      'api:GetRecord' => {
        'api:Id' => '123'
      }
    }
  }
}

Parsing XML Responses

Navigate with dig:

response = get('/api/record')
  .response_format_xml

# Access nested elements
name = response.dig('Envelope', 'Body', 'GetRecordResponse', 'Record', 'Name')

# Access attributes
id = response.dig('Envelope', 'Body', 'GetRecordResponse', 'Record', '@id')

# Handle arrays
items = response.dig('Envelope', 'Body', 'GetRecordResponse', 'Items', 'Item')
items = [items] unless items.is_a?(Array)  # Ensure array

Multipart Form Details

File Upload with Metadata

execute: lambda do |connection, input|
  post('/api/upload')
    .payload(
      file: [
        input['file_content'],
        'application/octet-stream',     # Content type
        input['filename']               # Filename
      ],
      metadata: input['metadata'].to_json
    )
    .request_format_multipart_form
end

Multiple Files

execute: lambda do |connection, input|
  files = input['files'].map do |file|
    ['files[]', [file['content'], file['content_type'], file['name']]]
  end

  post('/api/upload')
    .payload(Hash[files])
    .request_format_multipart_form
end

Content Type Headers

Override content type when needed:

execute: lambda do |connection, input|
  post('/api/data')
    .payload(input['raw_data'])
    .headers('Content-Type' => 'text/plain')
end

Combining Formats

Different request and response formats:

execute: lambda do |connection, input|
  # Send form-encoded, receive JSON
  response = post('/oauth/token')
    .payload(grant_type: 'client_credentials')
    .request_format_www_form_urlencoded
    # Response is JSON by default

  { access_token: response['access_token'] }
end

Reference Files

For detailed documentation:

references/guides__data-formats.md - Data formats overview
references/guides__data-formats__json-format.md - JSON format details
references/guides__data-formats__xml-format.md - XML format details
references/guides__data-formats__form-url-encoded.md - Form URL-encoded
references/guides__data-formats__request_format_multipart_form.md - Multipart form uploads