Connectors Reference

Plumsail Forms

This API allows you to subscribe to Plumsail Forms submissions

 

Status: Preview

Tier: Standard

Version: v1

 

Actions:

Name

Summary

Unsubscribe (string subscriberId)

Unsubscribe

GetCurrentUser ()

Get current user

 

Triggers:

Name

Summary

FormIsSubmitted ([Optional]Subscriber subscriber)

Form is submitted

 

Objects:

Name

Summary

Subscriber

 

 

Actions:

Unsubscribe

Summary: Unsubscribe

Description: Removes the subscriber

 

Syntax:

PlumsailForms.Unsubscribe (string subscriberId)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscriberId

string(uuid)

 

 

True

 

Returns:

 

GetCurrentUser

Summary: Get current user

Description: Returns an e-mail address of the current user

 

Syntax:

PlumsailForms.GetCurrentUser ()

 

Returns:

 

Triggers:

Trigger FormIsSubmitted

Summary: Form is submitted

Description: Fires whenever the target form is submitted

 

Syntax:

PlumsailForms.FormIsSubmitted ([Optional]Subscriber subscriber)

 

Parameters:

Name

Type

Summary

Required

Related Action

subscriber

Subscriber

 

 

False

 

Returns:

 


 

Subscriber

Summary:

Description:

 

          Properties:

Name

Type

Summary

formId

string(uuid)

Form ID

The ID of a form which submissions you want to track.

callbackUrl

string