Cognito Forms
![](https://connectoricons-prod.azureedge.net/releases/v1.0.1705/1.0.1705.3833/cognitoforms/icon.png)
Cognito Forms lets you easily build powerful online forms, such as surveys, order forms, registration forms and more. For free.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Standard | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Standard | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Cognito Forms Support |
URL | https://www.cognitoforms.com/support |
support@cognitoforms.com |
Connector Metadata | |
---|---|
Publisher | Cognito Forms |
Website | https://www.cognitoforms.com |
Privacy Policy | https://www.cognitoforms.com/legal/privacy |
Categories | Productivity;Collaboration |
Cognito Forms
Cognito Forms lets you easily build powerful online forms, such as surveys, order forms, registration forms and more. For free. Please see our support documentation or contact us for help with our public Power Automate connector.
Publisher: Cognito Forms
Prerequisites
A paid subscription is required.
Supported Operations
Triggers
Triggers will be sent shortly after the subscribed event occurs.
NewEntry
This will be triggered when a new entry is created for the specified form. The output will be the entry data, including file data and temporary links to files, signatures, and entry documents.
Parameters:
form
: The name of the form for which new entry events will be subscribed.
UpdateEntry
This will be triggered when an entry is updated for the specified form. The output will be the entry data, including file data and temporary links to files, signatures, and entry documents.
Parameters:
form
: The name of the form for which updated entry events will be subscribed.
EntryDeleted
This will be triggered when an entry is deleted for the specified form. The output will be the entry data, excluding links.
Parameters:
form
: The name of the form for which entry deleted events will be subscribed.
Actions
CreateEntry
This action will create an entry for the specified form. The action will include settable properties for each entry field, excluding some field types. The output will be the entry data.
Parameters:
form
: The internal form name or Id
EditEntry
This action will update an existing entry for the specified form. The action will include settable properties for each entry field, excluding some field types. This action will fail if the entry includes a paid order or the entryId does not exist. The output will be the updated entry data.
Parameters:
form
: The internal form name or IdentryId
: The entry number or entry Id for the entry to be updated
SetFormAvailability
This action will set the form's limit availability settings.
The start
and end
parameters should be blank to make the form available all of the time.
The output will be the updated availability settings.
Parameters:
form
: The internal form name or Idstart
: The datetime at which the form should become available.end
: The datetime at which the form should no longer be available.message
: The message which should be shown to users who try to access the form when outside of the availability period.
GetFile
This action will retrieve a file from storage. The output will be an object containing the file data, the metadata, and a temporary link to the file.
Parameters:
id
: The file Id for the file to be retrieved.
GetDocument
This action will generate and retrieve an entry document using the specified form, entry, and template. The output will be an object containing the document's file data, the metadata, and a temporary link to the document.
Parameters:
form
: The internal form name or Identry
: The entry Id or entry number of the entry for which the document should be generatedtemplateNumber
: The number of the template that should be used to generate the entry document
GetEntry
This action will get an existing entry for the specified form. This action will fail if the entry does not exist. The output will be the entry data.
Parameters:
form
: The internal form name or IdentryId
: The entry number or entry Id for the entry to be retrieved
DeleteEntry
This action will delete an existing entry for the specified form. This action will fail if the entry does not exist. There will be no output.
Parameters:
form
: The internal form name or IdentryId
: The entry number or entry Id for the entry to be deleted
Private Operations
These operations are enablers for the public triggers and actions.
GetForms
This operation will return a list of forms as objects that contain the Id
, InternalName
, and Name
.
When used for the form
parameter for actions and triggers, the user should see the Name
,
but the InternalName
should be sent to the API.
GetFormSchema
This operation will return the schema for the specified form.
The input
parameter should be true for actions to exclude read-only properties and false for triggers to include all properties.
The includeLinks
parameter should be true for all actions and triggers except for EntryDeleted.
Parameters:
form
: The internal form name or Idinput
: A boolean indicating whether the schema returned should exclude properties that cannot be set. False by default.includeLinks
: A boolean indicating whether link properties for files, signatures, and documents should be included in the schema. True by default.
UnsubscribeWebhook
This operation will unsubscribe the specified webhook. The webhook will no longer receive any events after all currently queued events have been sent.
Parameters:
id
: The Id of the webhook that should be unsubscribed.module
: The webhook's module. This should be set to "forms", as this connector only supports that module.
Obtaining Credentials
An owner of the organization must log into Cognito Forms and authorize the connection.
Known Issues
None
Deployment Instructions
Cognito Forms requires a valid Client id
and Client secret
to create a connector.
These properties can be found in the key vault and should only be set in the custom connector's authentication settings.
Run:
paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json
Login to PowerAutomate
Navigate to the new connector
Under "Security" update the
Client id
andClient secret
Update the connector
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Actions
Create entry |
Creates a new entry. |
Delete entry |
Delete an entry. |
Get Document |
Gets a document |
Get entry |
Gets an entry. |
Get file |
Gets a file by id |
Set form availability |
Sets the availability of a form. |
Update entry |
Updates an entry. |
Create entry
Creates a new entry.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Form
|
form | True | string |
The name of the form |
Entry
|
entry | True | dynamic |
The entry to create for the form |
Returns
Delete entry
Delete an entry.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Form
|
form | True | string |
The name of the form |
Entry Id
|
entryId | True | string |
The entry id |
Returns
Get Document
Gets a document
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Form
|
form | True | string |
The name of the form |
Entry Id
|
entry | True | string |
The entry id |
Template Number
|
templateNumber | True | integer |
The template number |
Returns
A file reference that includes file data and metadata
- Body
- FileDataRef
Get entry
Gets an entry.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Form
|
form | True | string |
The name of the form |
Entry Id
|
entryId | True | string |
The entry id |
Returns
Get file
Gets a file by id
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Id
|
id | True | string |
The unique identifier of the file |
Returns
A file reference that includes file data and metadata
- Body
- FileDataRef
Set form availability
Sets the availability of a form.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Form
|
form | True | string |
The name of the form |
Availability Start
|
start | date-time |
Availability start date |
|
Availability End
|
end | date-time |
Availability end date |
|
Not Available Message
|
message | string |
Not Available Message |
Returns
Form availability information such as start/end availability and not available message.
- Body
- FormAvailability
Update entry
Updates an entry.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Form
|
form | True | string |
The name of the form |
Entry Id
|
entryId | True | string |
The entry id |
Entry
|
entry | True | dynamic |
The updated entry data |
Returns
Triggers
When a new entry is created |
Triggers when someone creates a new entry. |
When an entry is deleted |
Triggers when someone deletes an entry. |
When an entry is updated |
Triggers when someone updates an entry. |
When a new entry is created
Triggers when someone creates a new entry.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Form
|
publisher | True | string |
The name of the form |
Returns
When an entry is deleted
Triggers when someone deletes an entry.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Form
|
publisher | True | string |
The name of the form |
Returns
When an entry is updated
Triggers when someone updates an entry.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Form
|
publisher | True | string |
The name of the form |
Returns
Definitions
FileDataRef
A file reference that includes file data and metadata
Name | Path | Type | Description |
---|---|---|---|
File Id
|
Id | string |
The unique id of the file. |
File Name
|
Name | string |
The name of the file |
File Content Type
|
ContentType | string |
The content type of the file. |
File Size
|
Size | integer |
The size of the file. |
File URL
|
File | string |
The URL of the file. |
File Content
|
Content | byte |
The file content |
FormAvailability
Form availability information such as start/end availability and not available message.
Name | Path | Type | Description |
---|---|---|---|
Form availability start
|
availabilityStart | date-time |
Form availability start |
Form availability end
|
availabilityEnd | date-time |
Form availability end |
Not available message
|
notAvailableMessage | string |
Not available message |