Plumsail Forms

This API allows you to subscribe to Plumsail Forms submissions

 

Status: Production

Tier: Standard

Version: v1

 

Actions:

Name	Summary
GetPublicForms ([Optional]integer format, string version)	Get public forms
GetFormSchema (string formId)	Get form schema
Unsubscribe (string subscriberId)	Unsubscribe

 

Triggers:

Name	Summary
FormIsSubmitted (FormIsSubmittedParameterSubscriber subscriber)	Form is submitted

 

Objects:

Name	Summary
Form
FormIsSubmittedParameterSubscriber

 

Actions:

GetPublicForms

Summary: Get public forms

Description: Returns an array of public forms

 

Syntax:

 

Parameters:

Name	Type	Summary	Required	Related Action
format	integer(int32) Values: [, ]		False
version	string		True

 

Returns:

          Type:array of (Form)

 

GetFormSchema

Summary: Get form schema

Description: Returns schema of the specified form

 

Syntax:

 

Parameters:

Name	Type	Summary	Required	Related Action
formId	string(uuid) (Form ID)		True

 

Returns:

 

Unsubscribe

Summary: Unsubscribe

Description: Removes the subscriber

 

Syntax:

 

Parameters:

Name	Type	Summary	Required	Related Action
subscriberId	string(uuid)		True

 

Returns:

 

Triggers:

Trigger FormIsSubmitted

Summary: Form is submitted

Description: Fires whenever the target form is submitted

 

Syntax:

 

Parameters:

Name	Type	Summary	Required	Related Action
subscriber	FormIsSubmittedParameterSubscriber		True

 

Returns:

 

 

Form

Summary:

Description:

 

          Properties:

Name	Type	Summary
id	string(uuid)
name	string

 

FormIsSubmittedParameterSubscriber

Summary:

Description:

 

          Properties:

Name	Type	Summary
callbackUrl	string
formId	string(uuid) Form	The form which submissions you want to track.