Cognito Forms lets you easily build powerful online forms, such as surveys, order forms, registration forms and more. For free.
Status: Preview |
Tier: Standard |
Version: 1.0 |
Name |
Summary |
Get forms |
|
Create entry |
|
Get form schema |
|
UnsubscribeWebhook ([Optional]string id, [Optional]string module) |
Unsubscribe Webhook |
Name |
Summary |
NewEntry ([internal]string module, string publisher, NewEntryParameterEndpoint endpoint) |
When a new entry is created |
UpdateEntry ([internal]string module, string publisher, UpdateEntryParameterEndpoint endpoint) |
When a new entry is updated |
Name |
Summary |
|
|
|
|
|
|
|
|
|
Summary: Get forms
Description: Gets the list of available forms.
Syntax:
CognitoForms.GetForms ()
Returns:
Type:array of (FormRef)
Summary: Create entry
Description: Creates a new entry.
Syntax:
CognitoForms.CreateEntry (string form, CreateEntryParameterEntry entry)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
form |
string (Form) |
The name of the form |
True |
|
entry |
|
|
True |
Returns:
Summary: Get form schema
Description: Gets the Swagger schema for a specific form.
Syntax:
CognitoForms.GetFormSchema (string form)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
form |
string (Form) |
The name of the form. |
True |
Returns:
Summary: Unsubscribe Webhook
Description: Unsubscribes a webhook.
Syntax:
CognitoForms.UnsubscribeWebhook ([Optional]string id, [Optional]string module)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
string (Subscription) |
The unique subscription id. |
False |
|
module |
string (Module) |
The module the subscription is associated with. |
False |
Returns:
Summary: When a new entry is created
Description: Triggers when someone creates a new entry.
Syntax:
CognitoForms.NewEntry ([internal]string module, string publisher, NewEntryParameterEndpoint endpoint)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
module |
string
|
|
True |
|
publisher |
string (Form) |
The name of the form |
True |
|
endpoint |
|
|
True |
Returns:
Summary: When a new entry is updated
Description: Triggers when someone updates an entry.
Syntax:
CognitoForms.UpdateEntry ([internal]string module, string publisher, UpdateEntryParameterEndpoint endpoint)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
module |
string
|
|
True |
|
publisher |
string (Form) |
The name of the form |
True |
|
endpoint |
|
|
True |
Returns:
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description: A form reference that includes the name and id of the form.
Properties:
Name |
Type |
Summary |
Id |
string Form Id |
The unique id of the form. |
Name |
string Form Name |
The name of the form. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
notificationUrl |
string Notification URL |
The URL to call back to. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
notificationUrl |
string Notification URL |
The URL to call back to. |