Connectors Reference

Nitro

Get your documents signed smarter, faster and more securely with Nitro Sign - without the need for paper or pen.

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

TemplateSummaries ()

List the template summaries

TemplateSignatureRequestSchema (string id)

Get the dynamic schema for a template

TemplateSignatureRequest (string id, [Optional]TemplateSignatureRequestParameterDynamicSchema dynamicSchema)

Send a signature request using a template

 

Triggers:

Name

Summary

webhookDocumentSignedTriggetr (webhookDocumentSignedTriggetrParameterRequest request)

When a signature request is completed

 

Objects:

Name

Summary

TemplateSignatureRequestParameterDynamicSchema

 

TemplateSignatureRequestSchemaResponse

 

TemplateSummariesResponse

 

webhookDocumentSignedTriggetrParameterRequest

 

 

Actions:

TemplateSummaries

Summary: List the template summaries

Description: List the current user template summaries.

 

Syntax:

Nitro.TemplateSummaries ()

 

Returns:

          Type:TemplateSummariesResponse

 

TemplateSignatureRequestSchema

Summary: Get the dynamic schema for a template

Description: Get the dynamic schema to perform a signature request for a template.

 

Syntax:

Nitro.TemplateSignatureRequestSchema (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Template ID)

 

True

 

Returns:

          Type:TemplateSignatureRequestSchemaResponse

 

TemplateSignatureRequest

Summary: Send a signature request using a template

Description: Send a signature request using an existing template.

 

Syntax:

Nitro.TemplateSignatureRequest (string id, [Optional]TemplateSignatureRequestParameterDynamicSchema dynamicSchema)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Template)

Use this option to select the template to be used for the signature request.

True

TemplateSummaries

dynamicSchema

TemplateSignatureRequestParameterDynamicSchema

 

 

False

 

Returns:

 

Triggers:

Trigger webhookDocumentSignedTriggetr

Summary: When a signature request is completed

Description: Triggers when a signature request is completed by all parties

 

Syntax:

Nitro.webhookDocumentSignedTriggetr (webhookDocumentSignedTriggetrParameterRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

webhookDocumentSignedTriggetrParameterRequest

 

 

True

 

Returns:

 


 

TemplateSignatureRequestParameterDynamicSchema

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

TemplateSignatureRequestSchemaResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

items

Items

 

 

 

Items

Summary:

Description:

 

          Properties:

Name

Type

Summary

type

string

 

 

required

array of (string)

 

 

properties

Properties

 

 

 

Properties

Summary:

Description:

 

          Properties:

Name

Type

Summary

subject

Subject

 

 

message

Message

 

 

 

Subject

Summary:

Description:

 

          Properties:

Name

Type

Summary

type

string

 

 

description

string

 

 

 

Message

Summary:

Description:

 

          Properties:

Name

Type

Summary

type

string

 

 

description

string

 

 

 


 

TemplateSummariesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

items

array of (ItemsItem)

 

 

 

ItemsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

name

string

 

 

 


 

webhookDocumentSignedTriggetrParameterRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

endpoint

string

 

 

event

string