TypeformClient

Attributes

ListFormsResponseOld module-attribute

ListFormsResponseOld = List[Dict[str, Any]]

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'NewResponseWebhook_V2': {'operation_id': 'NewResponseWebhook_V2', 'path': '/{connectionId}/v2/forms/{form_id}/webhooks/{tag}', 'method': 'post', 'required_parameters': ['form_id', 'tag', 'body'], 'callback_payload_type': 'WebhookCreationResponse'}}

Classes

NewResponseWebhookInput dataclass

NewResponseWebhookInput(url: Optional[str] = None, enabled: Optional[bool] = None)

When a response is submitted

Attributes

url class-attribute instance-attribute

url: Optional[str] = None

Webhook URL.

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

Yes if you want to send responses to the webhook immediately. Otherwise, no.

WebhookCreationResponse dataclass

WebhookCreationResponse(id: Optional[str] = None, form_id: Optional[str] = None, tag: Optional[str] = None, url: Optional[str] = None, enabled: Optional[bool] = None, created_at: Optional[str] = None, updated_at: Optional[str] = None)

Response for When a response is submitted

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

Unique ID of the webhook

form_id class-attribute instance-attribute

form_id: Optional[str] = None

Unique ID of the typeform

tag class-attribute instance-attribute

tag: Optional[str] = None

Unique name you want to use for the webhook

url class-attribute instance-attribute

url: Optional[str] = None

Webhook URL

enabled class-attribute instance-attribute

enabled: Optional[bool] = None

True if you want to send responses to the webhook immediately. Otherwise, false.

created_at class-attribute instance-attribute

created_at: Optional[str] = None

Date and time when webhook was created. In ISO 8601 format, UTC time, to the second, with T as a delimiter between the date and time.

updated_at class-attribute instance-attribute

updated_at: Optional[str] = None

Date of last update to webhook. In ISO 8601 format, UTC time, to the second, with T as a delimeter between the date and time.

ListFormsResponse dataclass

ListFormsResponse(total_items: Optional[int] = None, page_count: Optional[int] = None, items: Optional[List[Dict[str, Any]]] = None)

Response for List forms

Attributes

total_items class-attribute instance-attribute

total_items: Optional[int] = None

Total number of forms.

page_count class-attribute instance-attribute

page_count: Optional[int] = None

Number of pages of results.

items class-attribute instance-attribute

items: Optional[List[Dict[str, Any]]] = None

Forms in response.

ResponseList dataclass

ResponseList(responses: Optional[List[Item]] = None)

Definition: ResponseList

Item dataclass

Item(item_internal_id: Optional[str] = None)

Definition: Item

ItemNew dataclass

ItemNew(item_internal_id: Optional[str] = None)

Definition: Item-New

WebhookPayload dataclass

WebhookPayload(event_id: Optional[str] = None, event_type: Optional[str] = None, form_response: Optional[Dict[str, Any]] = None)

Definition: WebhookPayload

Attributes

event_id class-attribute instance-attribute

event_id: Optional[str] = None

Unique ID for the webhook. Automatically assigned by Typeform.

event_type class-attribute instance-attribute

event_type: Optional[str] = None

Reason the webhook is being sent.

form_response class-attribute instance-attribute

form_response: Optional[Dict[str, Any]] = None

Object that contains information about the typeform and account associated with the webhook.

TypeformClient

TypeformClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for typeform connector.

Initialize a TypeformClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

list_forms_async async

list_forms_async(search: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, workspace_id: Optional[str] = None) -> dict[str, Any] | None

List forms

Retrieves a list of JSON descriptions for all forms in your Typeform account (public and private).

get_schema_async async

get_schema_async(form_id: str) -> dict[str, Any] | None

Get schema

Get schema