Skip to content

FormstackformsClient

Attributes

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'FormstackFormSubmitted': {'operation_id': 'FormstackFormSubmitted', 'path': '/{connectionId}/api/v2/form/{form_id}/webhook/', 'method': 'post', 'required_parameters': ['form_id', 'body'], 'callback_payload_type': 'FormstackFormSubmittedResponse'}}

Classes

FormstackFormSubmittedInput dataclass

FormstackFormSubmittedInput(url: Optional[str] = None, content_type: Optional[str] = None, file_transfer_type: Optional[str] = None, standardize_field_values: Optional[bool] = None)

Triggers when a form is submitted

Attributes

url class-attribute instance-attribute
url: Optional[str] = None

url

content_type class-attribute instance-attribute
content_type: Optional[str] = None

content type

file_transfer_type class-attribute instance-attribute
file_transfer_type: Optional[str] = None

file transfer type

standardize_field_values class-attribute instance-attribute
standardize_field_values: Optional[bool] = None

standardize field values

FormstackFormSubmittedResponse dataclass

FormstackFormSubmittedResponse(id: Optional[str] = None)

Response for Triggers when a form is submitted

GetAvailableFormsResponse dataclass

GetAvailableFormsResponse(forms: Optional[List[Dict[str, Any]]] = None, total: Optional[int] = None)

Response for Get Available Forms

Attributes

forms class-attribute instance-attribute
forms: Optional[List[Dict[str, Any]]] = None

forms

total class-attribute instance-attribute
total: Optional[int] = None

total

FormstackformsClient

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

Bases: ConnectorClientBase

Typed client for formstackforms connector.

Initialize a FormstackformsClient.

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:

get_available_forms_async async
get_available_forms_async() -> dict[str, Any] | None

Get Available Forms

Returns all available forms

get_form_schema_async async
get_form_schema_async(form_id: int) -> None

Returns Form Schema from Webhook API

Used for the x-ms-dynamic-schema