Connectors Reference

Elastic Forms

Build advanced and interactive forms!

 

Status: Preview

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

DeleteHook (string hookId)

Delete hook

ListForms ()

List forms

AssignForm (AssignFormParameterForm assign body Form assign body)

Assign form

GetSchema (string FormUid)

Get schema

AddData (AddDataParameterForm data body Form data body)

Fill form

ListUsers ([Optional]string query)

Users list

 

Triggers:

Name

Summary

TrigNewResponse (TrigNewResponseParameterRequest body of webhook Request body of webhook)

When form is filled

 

Objects:

Name

Summary

AddDataParameterForm data body

 

AssignFormParameterForm assign body

 

AssignFormResponse

 

ListFormsResponseItem

 

ListUsersResponseItem

 

TrigNewResponseParameterRequest body of webhook

 

 

Actions:

DeleteHook

Summary: Delete hook

Description: Delete a hook.

 

Syntax:

ElasticForms.DeleteHook (string hookId)

 

Parameters:

Name

Type

Summary

Required

Related Action

hookId

string

 

 

True

 

Returns:

 

ListForms

Summary: List forms

Description: Forms list

 

Syntax:

ElasticForms.ListForms ()

 

Returns:

          Type:array of (ListFormsResponseItem)

 

AssignForm

Summary: Assign form

Description: Assign form

 

Syntax:

ElasticForms.AssignForm (AssignFormParameterForm assign body Form assign body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Form assign body

AssignFormParameterForm assign body

 

 

True

 

Returns:

          Type:AssignFormResponse

 

GetSchema

Summary: Get schema

Description: Get schema

 

Syntax:

ElasticForms.GetSchema (string FormUid)

 

Parameters:

Name

Type

Summary

Required

Related Action

FormUid

string

(Form)

Form

True

ListForms

 

Returns:

          Type:string

 

AddData

Summary: Fill form

Description: Fill form

 

Syntax:

ElasticForms.AddData (AddDataParameterForm data body Form data body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Form data body

AddDataParameterForm data body

 

 

True

 

Returns:

          Type:string

 

ListUsers

Summary: Users list

Description: Users list

 

Syntax:

ElasticForms.ListUsers ([Optional]string query)

 

Parameters:

Name

Type

Summary

Required

Related Action

query

string

(User query)

User query

False

 

Returns:

          Type:array of (ListUsersResponseItem)

 

Triggers:

Trigger TrigNewResponse

Summary: When form is filled

Description: Triggers when form is filled.

 

Syntax:

ElasticForms.TrigNewResponse (TrigNewResponseParameterRequest body of webhook Request body of webhook)

 

Parameters:

Name

Type

Summary

Required

Related Action

Request body of webhook

TrigNewResponseParameterRequest body of webhook

 

 

True

 

Returns:

 


 

AddDataParameterForm data body

Summary:

Description:

 

          Properties:

Name

Type

Summary

FormUid

string

Form

Form

FormDataObject

FormDataObject

Fields

Fields

 

FormDataObject

Summary: Fields

Description: Fields

 

          Properties:

Name

Type

Summary

 


 

AssignFormParameterForm assign body

Summary:

Description:

 

          Properties:

Name

Type

Summary

UserName

string

User

User

FormUid

string

Form

Form

FormData

FormData

Fields

Fields

 

FormData

Summary: Fields

Description: Fields

 

          Properties:

Name

Type

Summary

 


 

AssignFormResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

AssignedFormUrl

string

 

 


 

ListFormsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Uid

string

Form UID

 

Title

string

Form title

 


 

ListUsersResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

UserName

string

User Name

 

Value

string

Form name

 


 

TrigNewResponseParameterRequest body of webhook

Summary:

Description:

 

          Properties:

Name

Type

Summary

TriggerUrl

string

 

 

FormUid

string

Form

Form