Overview
Configuration is provided for establishing connections with Typeform service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Demonstration
Quick Start
In this guide, we will show how to read data from the Typeform service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select Typeform connection from the combo. Select from available Typeform resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select Typeform resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from Typeform service.
In this guide, we will show how to write data to the Typeform service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select Typeform connection from the combo. Also, select resource action and Typeform resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Typeform resource.
Configuration
Base URL address: https://api.typeform.com.
- OAuth 2
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- Scope: https://developer.typeform.com/get-started/scopes/
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://developer.typeform.com/get-started/applications/#3-write-your-application.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/images.Documentation: https://developer.typeform.com/create/reference/retrieve-images-collection/.
- [Read single] action
-
Endpoint URL address:
/images/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the image_id.
Documentation: https://developer.typeform.com/create/reference/retrieve-image/.
- [Read Image By Size] action
-
Endpoint URL address:
/images/{{=parameters.id}}/{{=parameters.size}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the image_id.
- size: Required. Specify the size.
Documentation: https://developer.typeform.com/create/reference/retrieve-image-by-size/.
- [Read Background By Size] action
-
Endpoint URL address:
/images/{{=parameters.id}}/background/{{=parameters.size}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the image_id.
- size: Required. Specify the size.
Documentation: https://developer.typeform.com/create/reference/retrieve-background-by-size/.
- [Read Choice Image By Size] action
-
Endpoint URL address:
/images/{{=parameters.id}}/choice/{{=parameters.size}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the image_id.
- size: Required. Specify the size.
Documentation: https://developer.typeform.com/create/reference/retrieve-choice-image-by-size/.
- [Create] action
-
Endpoint URL address:
/images.Documentation: https://developer.typeform.com/create/reference/create-image/.
- [Delete] action
-
Endpoint URL address:
/images/{{=item.id}}.Documentation: https://developer.typeform.com/create/reference/delete-image/.
- id
A key field. Template: ShortText.
- src
Template: ShortText.
- file_name
Template: ShortText.
- width
Data type: DT_I4
- height
Data type: DT_I4
- media_type
Template: ShortText.
- has_alpha
Data type: DT_BOOL
- avg_color
Template: ShortText.
- url
Template: ShortText.
- image
Data type: DT_IMAGE The value is gathered from
/images/{{=item.id}}address. Before setting, the value is processed with{{=getClrType('System.Convert').ToBase64String(value.readAll())}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/forms.Documentation: https://developer.typeform.com/create/reference/retrieve-forms/.
- [Read single] action
-
Endpoint URL address:
/forms/{{=parameters.form_id}}.
The result is extracted from:{{= [response] }}.The action has the following user-defined parameters:
- form_id: Required. Specify the form_id.
Documentation: https://developer.typeform.com/create/reference/retrieve-form/.
- [Create] action
-
Endpoint URL address:
/forms.Documentation: https://developer.typeform.com/create/reference/create-form/.
- [Update] action
-
Endpoint URL address:
/forms/{{=item.id}}.Documentation: https://developer.typeform.com/create/reference/update-form/.
- [Delete] action
-
Endpoint URL address:
/forms/{{=item.id}}.Documentation: https://developer.typeform.com/create/reference/delete-form/.
- id
A key field. Template: ShortText.
- title
Template: ShortText.
- type
Template: ShortText.
- last_updated_at
Template: DateTime. A read-only field.
- self
Field components:
-
Uses template:
ShortText. - Contains the following components: href.
-
Uses template:
- _links
Field components:
-
Uses template:
ShortText. - Contains the following components: display.
-
Uses template:
- theme
Field components:
-
Uses template:
ShortText. - Contains the following components: href.
-
Uses template:
- webhook
The gathered value is processed with
{{=connection.resourceManager['Webhook'].getData({ parameters: ['id=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
WebhookT.
- insights
The value is gathered from
/insights/{{=item.id}}/summaryaddress. Field components:- Contains the following components: form, fields.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/themes.Documentation: https://developer.typeform.com/create/reference/retrieve-themes/.
- [Read single] action
-
Endpoint URL address:
/themes/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the theme_id.
Documentation: https://developer.typeform.com/create/reference/retrieve-theme/.
- [Create] action
-
Endpoint URL address:
/themes.Documentation: https://developer.typeform.com/create/reference/create-theme/.
- [Update] action
-
Endpoint URL address:
/themes/{{=item.id}}.Documentation: https://developer.typeform.com/create/reference/update-theme/.
- [Delete] action
-
Endpoint URL address:
/themes/{{=item.id}}.Documentation: https://developer.typeform.com/create/reference/delete-theme/.
- id
A key field. Template: ShortText.
- background
Field components:
-
Uses template:
ShortText. - Contains the following components: brightness, image_id, layout, href.
-
Uses template:
- colors
Field components:
-
Uses template:
ShortText. - Contains the following components: answer, background, button, question.
-
Uses template:
- font
Template: ShortText.
- screens
Field components:
-
Uses template:
ShortText. - Contains the following components: font_size, alignment.
-
Uses template:
- fields
Field components:
-
Uses template:
ShortText. - Contains the following components: font_size, alignment.
-
Uses template:
- has_transparent_button
Data type: DT_BOOL
- name
Template: ShortText.
- visibility
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/workspaces.Documentation: https://developer.typeform.com/create/reference/retrieve-workspaces/.
- [Read single] action
-
Endpoint URL address:
/workspaces/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the workspace_id.
Documentation: https://developer.typeform.com/create/reference/retrieve-workspace/.
- [Read account] action
-
Endpoint URL address:
/accounts/{{=parameters.id}}.The action has the following user-defined parameters:
- id: Required. Specify the account_id.
Documentation: https://developer.typeform.com/create/reference/retrieve-account-workspaces/.
- [Create] action
-
Endpoint URL address:
/workspaces.Documentation: https://developer.typeform.com/create/reference/create-workspace/.
- [Update] action
-
Endpoint URL address:
/workspaces/{{=item.id}}.
The action uses PATCH method.The following request parameters will be automatically processed:
-
application/json:
{{= [item] }}
Documentation: https://developer.typeform.com/create/reference/update-workspace/.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/workspaces/{{=item.id}}.Documentation: https://developer.typeform.com/create/reference/delete-workspace/.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- account_id
Template: ShortText.
- shared
Data type: DT_BOOL
- forms
Field components:
- An array.
- Contains the following components: href, count.
- self
Field components:
- An array.
- members
Field components:
- An array.
- Contains the following components: name, email, role.
- op
Template: ShortText.
- path
Template: ShortText.
- value
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/forms/{{=parameters.id}}/webhooks.The action has the following user-defined parameters:
- id: Required. Specify the form_id.
Documentation: https://developer.typeform.com/webhooks/reference/retrieve-webhooks/.
- [Read single] action
-
Endpoint URL address:
/forms/{{=parameters.id}}/webhooks/{{=parameters.tag}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the form_id.
- tag: Required. Specify the tag.
Documentation: https://developer.typeform.com/create/reference/retrieve-workspace/.
- [Create] action
-
Endpoint URL address:
/forms/{{=item.form_id}}/webhooks/{{=item.tag}}.
The action uses PUT method.Documentation: https://developer.typeform.com/webhooks/reference/create-or-update-webhook/.
- [Delete] action
-
Endpoint URL address:
/forms/{(=item.form_id}}/webhooks/{{=item.tag}}.Documentation: https://developer.typeform.com/webhooks/reference/delete-webhook/.
The resource includes the fields from the WebhookT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/forms/{{=parameters.form_id}}/responses.The action has the following user-defined parameters:
- form_id: Required. Specify the form_id.
Documentation: https://developer.typeform.com/responses/reference/retrieve-responses/.
- [Delete] action
-
Endpoint URL address:
/forms/{{=parameters.form_id}}/responses.The action has the following user-defined parameters:
- form_id: Required. Specify the form_id.
The following request parameters will be automatically processed:
-
included_response_ids:
{{=_.pluck(batch, 'response_id').join()}}
Documentation: https://developer.typeform.com/responses/reference/delete-response.
- response_id
A key field. Template: ShortText.
- landing_id
Template: ShortText.
- token
Template: ShortText.
- landed_at
Template: DateTime. A read-only field.
- submitted_at
Template: DateTime. A read-only field.
- metadata
Field components:
-
Uses template:
ShortText. - Contains the following components: user_agent, platform, referer, network_id, browser.
-
Uses template:
- hidden
Template: LongText. A composite field.
- calculated
Field components:
- Contains the following components: score.
- [External]
-
The external fields URL address:
/forms/{{=parameters.form_id}}. The external fields list is extracted from:{{=response.fields}}.- answer.{{=external.ref}}
Data type: {{=Typeform.getDataType(external.type)}} ( length {{=255}} )
- [Read] action
-
The result is extracted from:{{=response.items}}.
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
page_size:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
page:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- TypeValue
Field components:
-
Uses template:
ShortText. - Contains the following components: type, value.
-
Uses template:
- formAttachmentT
Field components:
-
Uses template:
ShortText. - Contains the following components: type, href, scale, properties.
-
Uses template:
- formLayoutT
Field components:
-
Uses template:
ShortText. - Contains the following components: type, placement, attachment.
-
Uses template:
- WebhookT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, form_id, tag, url, enabled, verify_ssl, created_at, updated_at.
-
Uses template:
What's New
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.