Connectors Reference

airSlate

Use airSlate to make MS Dynamics 365 workflows configurable in minutes without ever having to leave Dynamics. Automate routine tasks in airSlate by:  * Generating documents pre-filled with Dynamics 365 data  * Creating new client records based on data entered into a document’s fillable fields  * Updating existing client records based on data entered into a document’s fillable fields  * Saving e-signed documents to Dynamics 365  * Conditional routing of document workflows to multiple recipients.

 

Status: Preview

Tier: Premium

Version: 1.1

 

Actions:

Name

Summary

StartFlow (string Organization-Domain, [internal]string Content-Type, string slateId, [Optional]StartFlowParameterFields fields)

Create new slate

GetAddonsScheme (string flowId, string Organization-Domain)

Get bot scheme

GetFlow ([Optional]string last_activity, [Optional]string search, [Optional]string sort, integer per_page, string Organization-Domain)

Get Flow

SendFlow (string Organization-Domain, string slateId, string packetId, [Optional]SendFlowParameterBody body)

Send Slate

UserMe (string include)

Get user information

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

GetAddonsSchemeResponse

 

GetFlowResponse

 

SendFlowParameterBody

 

SendFlowResponse

 

StartFlowParameterFields

 

StartFlowResponse

 

UserMeResponse

 

 

Actions:

StartFlow

Summary: Create new slate

Description: Generate a new slate for editing or signing from the flow in your airSlate organization

 

Syntax:

airSlate.StartFlow (string Organization-Domain, [internal]string Content-Type, string slateId, [Optional]StartFlowParameterFields fields)

 

Parameters:

Name

Type

Summary

Required

Related Action

Organization-Domain

string

(Organization)

Select an airSlate organization where you will save and manage the new slate

True

UserMe

Content-Type

string

 

Application specific mime-type

True

slateId

string

(Flow)

Select the flow to generate a slate from

True

GetFlow

fields

StartFlowParameterFields

 

 

False

 

Returns:

          Type:StartFlowResponse

 

GetAddonsScheme

Summary: Get bot scheme

Description: Retrieve the list of parameters available for your slate based on the bots configured for your airSlate flow

 

Syntax:

airSlate.GetAddonsScheme (string flowId, string Organization-Domain)

 

Parameters:

Name

Type

Summary

Required

Related Action

flowId

string

 

 

True

Organization-Domain

string

 

 

True

 

Returns:

          Type:GetAddonsSchemeResponse

 

GetFlow

Summary: Get Flow

Description: Retrieve the list of flows by the organization it was created in

 

Syntax:

airSlate.GetFlow ([Optional]string last_activity, [Optional]string search, [Optional]string sort, integer per_page, string Organization-Domain)

 

Parameters:

Name

Type

Summary

Required

Related Action

last_activity

string

 

 

False

search

string

 

 

False

sort

string

Values: [name, updated_at, last_activity]

 

False

per_page

integer

Values: []

 

True

Organization-Domain

string

 

 

True

UserMe

 

Returns:

          Type:GetFlowResponse

 

SendFlow

Summary: Send Slate

Description: Send a slate with documents and forms by email. This action is deprecated. Please, use Send a Slate bot instead

 

Syntax:

airSlate.SendFlow (string Organization-Domain, string slateId, string packetId, [Optional]SendFlowParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

Organization-Domain

string

(Organization)

Select an airSlate organization where you will save and manage the new slate

True

UserMe

slateId

string

(Flow)

Select the flow to send a slate from

True

GetFlow

packetId

string

(Slate ID)

Select the Slate ID as a custom value from the Create new slate step or copy and paste the ID from airSlate

True

body

SendFlowParameterBody

 

 

False

 

Returns:

          Type:SendFlowResponse

 

UserMe

Summary: Get user information

Description: Retrieve all data about the user: name, email address in the organization, activity status, etc.

 

Syntax:

airSlate.UserMe (string include)

 

Parameters:

Name

Type

Summary

Required

Related Action

include

string

 

 

True

 

Returns:

          Type:UserMeResponse

 


 

GetAddonsSchemeResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

properties

Properties

 

 

 

Properties

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

GetFlowResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (DataItem)

 

data

links

Links

 

links

meta

Meta

 

meta

 

DataItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

attributes

Attributes

 

attributes

id

string

 

id

relationships

Relationships

 

relationships

type

string

 

type

 

Attributes

Summary:

Description: attributes

 

          Properties:

Name

Type

Summary

created_at

string

 

created_at

description

string

 

description

is_editable

boolean

 

is_editable

last_activity

string

 

last_activity

name

string

 

name

source

string

 

source

updated_at

string

 

updated_at

wizard_status

string

 

wizard_status

 

Relationships

Summary:

Description: relationships

 

          Properties:

Name

Type

Summary

admin

Admin

 

admin

organization

Organization

 

organization

slate

Slate

 

slate

template

Template

 

template

 

Admin

Summary:

Description: admin

 

          Properties:

Name

Type

Summary

data

Data

 

data

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

id

string

 

id

type

string

 

type

 

Organization

Summary:

Description: organization

 

          Properties:

Name

Type

Summary

data

Data

 

data

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

id

string

 

id

type

string

 

type

 

Slate

Summary:

Description: slate

 

          Properties:

Name

Type

Summary

data

Data

 

data

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

id

string

 

id

type

string

 

type

 

Template

Summary:

Description: template

 

          Properties:

Name

Type

Summary

data

Data

 

data

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

id

string

 

id

type

string

 

type

 

Links

Summary:

Description: links

 

          Properties:

Name

Type

Summary

first

string

 

first

last

string

 

last

next

string

 

next

prev

string

 

prev

self

string

 

self

 

Meta

Summary:

Description: meta

 

          Properties:

Name

Type

Summary

current_page

integer(int32)

 

current_page

from

integer(int32)

 

from

last_page

integer(int32)

 

last_page

path

string

 

path

per_page

integer(int32)

 

per_page

to

integer(int32)

 

to

total

integer(int32)

 

total

 


 

SendFlowParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

Data

 

data

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

attributes

Attributes

 

attributes

type

string

 

type

 

Attributes

Summary:

Description: attributes

 

          Properties:

Name

Type

Summary

email

string

 

Recipient email

 


 

SendFlowResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

array of (DataItem)

 

data

links

Links

 

links

 

DataItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

attributes

Attributes

 

attributes

id

string

 

id

type

string

 

type

 

Attributes

Summary:

Description: attributes

 

          Properties:

Name

Type

Summary

created_at

string

 

created_at

email

string

 

email

updated_at

string

 

updated_at

user_id

string

 

user_id

 

Links

Summary:

Description: links

 

          Properties:

Name

Type

Summary

first

string

 

first

last

string

 

last

next

string

 

next

prev

string

 

prev

self

string

 

self

 


 

StartFlowParameterFields

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

StartFlowResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

Data

 

data

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

id

string

 

Packet id

 


 

UserMeResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

data

Data

 

data

included

array of (IncludedItem)

 

included

meta

Meta

 

meta

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

attributes

Attributes

 

attributes

id

string

 

id

meta

Meta

 

meta

relationships

Relationships

 

relationships

type

string

 

type

 

Attributes

Summary:

Description: attributes

 

          Properties:

Name

Type

Summary

auto_generated

integer(int32)

 

auto_generated

created_at

string

 

created_at

email

string

 

email

first_name

string

 

first_name

is_system

integer(int32)

 

is_system

last_name

string

 

last_name

status

string

 

status

updated_at

string

 

updated_at

username

string

 

username

 

Meta

Summary:

Description: meta

 

          Properties:

Name

Type

Summary

source

string

 

source

 

Relationships

Summary:

Description: relationships

 

          Properties:

Name

Type

Summary

organizations

Organizations

 

organizations

profile

Profile

 

profile

settings

Settings

 

settings

 

Organizations

Summary:

Description: organizations

 

          Properties:

Name

Type

Summary

data

array of (DataItem)

 

data

 

DataItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

id

type

string

 

type

 

Profile

Summary:

Description: profile

 

          Properties:

Name

Type

Summary

data

Data

 

data

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

id

string

 

id

type

string

 

type

 

Settings

Summary:

Description: settings

 

          Properties:

Name

Type

Summary

data

Data

 

data

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

id

string

 

id

type

string

 

type

 

IncludedItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

attributes

Attributes

 

attributes

id

string

 

id

meta

Meta

 

meta

relationships

Relationships

 

relationships

type

string

 

type

 

Attributes

Summary:

Description: attributes

 

          Properties:

Name

Type

Summary

auto_generated

integer(int32)

 

auto_generated

category

string

 

category

created_at

string

 

created_at

email_domains

array of (string)

 

email_domains

invite_domain

integer(int32)

 

invite_domain

logo_profile

string

 

logo_profile

logo_rectangle

string

 

logo_rectangle

name

string

 

name

size

string

 

size

subdomain

string

 

subdomain

updated_at

string

 

updated_at

 

Meta

Summary:

Description: meta

 

          Properties:

Name

Type

Summary

auto_generated

boolean

 

auto_generated

 

Relationships

Summary:

Description: relationships

 

          Properties:

Name

Type

Summary

organization_users

Organization_users

 

organization_users

owner

Owner

 

owner

settings

Settings

 

settings

 

Organization_users

Summary:

Description: organization_users

 

          Properties:

Name

Type

Summary

links

Links

 

links

 

Links

Summary:

Description: links

 

          Properties:

Name

Type

Summary

related

string

 

related

 

Owner

Summary:

Description: owner

 

          Properties:

Name

Type

Summary

data

Data

 

data

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

id

string

 

id

type

string

 

type

 

Settings

Summary:

Description: settings

 

          Properties:

Name

Type

Summary

data

Data

 

data

 

Data

Summary:

Description: data

 

          Properties:

Name

Type

Summary

id

string

 

id

type

string

 

type

 

Meta

Summary:

Description: meta

 

          Properties:

Name

Type

Summary

permissions

array of (string)

 

permissions