Connectors Reference

Cognito Forms

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

 

Actions:

Name

Summary

GetForms ()

Get forms

GetFormSchema (string form)

Get form schema

CreateEntry (string form, CreateEntryParameterEntry entry)

Create entry

UnsubscribeWebhook ([Optional]string id, [Optional]string module)

Unsubscribe Webhook

 

Triggers:

Name

Summary

NewEntry ([internal][Optional]string module, string publisher, [Optional]SubscriptionRequest endpoint)

When a new entry is created

UpdateEntry ([internal][Optional]string module, string publisher, [Optional]SubscriptionRequest endpoint)

When a new entry is updated

 

Objects:

Name

Summary

CreateEntryParameterEntry

 

FormRef

 

GetFormSchemaResponse

 

SubscriptionRequest

 

 

Actions:

GetForms

Summary: Get forms

Description: Gets the list of available forms.

 

Syntax:

CognitoForms.GetForms ()

 

Returns:

          Type:array of (FormRef)

 

GetFormSchema

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:

          Type:GetFormSchemaResponse

 

CreateEntry

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

GetForms

entry

CreateEntryParameterEntry

 

 

True

 

Returns:

 

UnsubscribeWebhook

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:

 

Triggers:

Trigger NewEntry

Summary: When a new entry is created

Description: Triggers when someone creates a new entry.

 

Syntax:

CognitoForms.NewEntry ([internal][Optional]string module, string publisher, [Optional]SubscriptionRequest endpoint)

 

Parameters:

Name

Type

Summary

Required

Related Action

module

string

 

 

False

publisher

string

(Form)

The name of the form

True

GetForms

endpoint

SubscriptionRequest

 

 

False

 

Returns:

 

Trigger UpdateEntry

Summary: When a new entry is updated

Description: Triggers when someone updates an entry.

 

Syntax:

CognitoForms.UpdateEntry ([internal][Optional]string module, string publisher, [Optional]SubscriptionRequest endpoint)

 

Parameters:

Name

Type

Summary

Required

Related Action

module

string

 

 

False

publisher

string

(Form)

The name of the form

True

GetForms

endpoint

SubscriptionRequest

 

 

False

 

Returns:

 


 

CreateEntryParameterEntry

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

FormRef

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.


 

GetFormSchemaResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

SubscriptionRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

notificationUrl

string

Notification URL

The URL to call back to.