Tilkee (Preview)

Tilkee is an online platform that makes cross-functional collaboration happen. Combining deep knowledge of sales enablement with augmented intelligence, the vision of the team behind Tilkee is to align marketing with sales and guide Sales, Product Marketing, Channel Enablement, and Customer Success teams towards digital transformation.

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
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Connector Metadata
Publisher Microsoft

Creating a connection

The connector supports the following authentication types:

Default Required parameters for creating connection. All regions

Default

Applicable: All regions

Required parameters for creating connection.

Name Type Description
API Key securestring API Key for this API (Bearer xxxxx)

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Add item(s) to a specific project

Add one or mutiple items to a specific project

Create a project, add document(s) and retrieve access link(s)

Create a project, add document(s) and retrieve access link(s) from this endpoint

Create access link(s)

Create access link(s) in a specific project

Create an item

Create a new item before adding it to a project

Get project information

Get project information

List and search items

List or search for items

List and search projects or templates

List or search for project or template

Update a project (verdict, consultable, downloadable...)

Update a project (verdict, consultable, downloadable...)

Upload information

Retrieve S3 upload information to upload file in Tilkee's platform. After retrieving this info, you should POST your file to 's3_endpoint, with key, acl, policy, signature & AWSAccessKeyId parameters. Amazon’s response is the URL you need to create your item in Tilkee.

Add item(s) to a specific project

Add one or mutiple items to a specific project

Parameters

Name Key Required Type Description
Project ID
project_id True string

Tilkee internal id of the project to add documents to

Name
title string

Document's title

Id
id integer

Unique id retrieved from /items call

Downloadable?
downloadable boolean

TRUE if the document can be downloaded

Signable?
signable boolean

TRUE if the document can be signed (for PDFs only)

Watermark
watermark string

Text & position to watermark on document (pdf only)

Returns

Name Path Type Description
array of object
ID
id integer

Project item id

Type
type string

Project item type

Element ID
element_id integer

Project item element_id

Title
title string

Project item title

Signable?
signable boolean

Project item signable?

Downloadable?
downloadable boolean

Project item downloadable?

ID
item.id integer

Item id

Title
item.title string

Item title

Usable
item.usable boolean

Item usable?

Extension
item.extension string

Item extension

Type
item.type string

Item type

External id
item.external_id string

Item external_id

Tags
item.tags array of string

Item tags

favorite
item.favorite boolean

Item favorite?

file_version
item.file_version integer

Item file_version

replaced_at
item.replaced_at string

Item replaced_at

file_size
item.file_size integer

Item file_size

num_pages
item.num_pages integer

Item num_pages

complete_base
item.convert_status.complete_base boolean

Item complete_base

complete_full
item.convert_status.complete_full boolean

Item complete_full

status
item.convert_status.status array of string

Item convert status

s3_url
item.s3_url string

Item url

content_url
item.content_url string

Item content_url

thumbnail_url
item.thumbnail_url string

Item thumbnail_url

visible
item.visible boolean

Item visible?

created_at
item.created_at string

Item created_at

Create a project, add document(s) and retrieve access link(s)

Create a project, add document(s) and retrieve access link(s) from this endpoint

Parameters

Name Key Required Type Description
Original project id
id string

Id of an existing project that will be duplicated

Project name
name True string

Project name

Downloadable?
can_be_downloaded boolean

TRUE if the documents can be downloaded

Consultable?
consultable boolean

TRUE if the project is consultable

Deadline (date)
consultable_until string

Allow consultation until this date

Tags
Tags string
Collaborators (Ids)
Collaborators (Ids)
Template?
is_template boolean

TRUE if this project will be used as a template

External Id
external_id string

Your internal id

Theme ID
id integer

An ID of theme

Name
name string

name

URL
s3_url string

Accessible URL of the document. This URL is retrieved after posting a file using ITEMS route OR by providing a public allowed URL, with from_url=TRUE

Base64 encoded content
content string

Base64 encoded content - must include MIME : data:file/pdf;base64,

Signable?
signable boolean

TRUE if the document can be signed - used ONLY with PDF files

From external URL?
from_url boolean

TRUE if Document URL is external to Tilkee

External Id
external_id string

ID of the contact in your system

Name
name string

Name of the unique generated link

External Id
external_id string

ID of the contact in your system

Returns

Name Path Type Description
Id
project.id integer
Name
project.name string
Preview url
project.preview_url string
External id
project.external_id string
URL
project.url string

available only with Marketing option

Edit
project.iframes.project_escape string
Links
project.iframes.tokens_escape string
Stats
project.iframes.stats_escape string
Link
tokens array of object
ID
tokens.id integer
Name
tokens.name string
URL
tokens.link string
External id
tokens.external_id string

Create access link(s)

Create access link(s) in a specific project

Parameters

Name Key Required Type Description
Project id
project_id True string

Tilkee internal id of the project to add links to

Name
name string

Name of the unique generated link

External Id
external_id string

ID of the contact in your system

Returns

Name Path Type Description
Link
contents array of object

Link

Link id
contents.id integer
Link name
contents.name string
Link URL
contents.link string
Link external id
contents.external_id string

Create an item

Create a new item before adding it to a project

Parameters

Name Key Required Type Description
Item type
type string

Choose between File, Text and Link

iFrame URL
url string

When type=link: accessible URL, which will be displayed in an iFrame

Document URL
s3_url string

When type=file: accessible URL of the document (retrieved after posting a file using direct upload route.

Text content
content string

When type=text: HTML content that will be displayed in viewer

Document name
title string

To be used with TEXT and LINK items only

File name
name string

To be used with FILE items only

External Id
external_id string

ID of the contact in your system

Returns

Name Path Type Description
Item
array of object

Item

Item id
id integer
Item title
title string
Item usable?
usable boolean
Item element_type?
element_type string
Item extension
extension string
Item type
type string
Item external_id
external_id string
Item tags
tags array of string
Item favorite?
favorite boolean
Item file_version
file_version integer
Item visible?
visible boolean
Item thumbnail_url
thumbnail_url string
Item created_at
created_at string
Item updated_at
updated_at string
Item replaced_at
replaced_at string
Item url
s3_url string
Item content_url
content_url string
Item convert complete_base
convert_status.complete_base boolean
Item convert complete_full
convert_status.complete_full boolean
Item convert status
convert_status.status array of
Item owner first_name
owner.first_name string
Item owner last_name
owner.last_name string
Item owner id
owner.id integer
Item owner email
owner.email string
Item owner avatar
owner.avatar string

Get project information

Get project information

Parameters

Name Key Required Type Description
Project id
id True string

Tilkee internal id of the project

Returns

Name Path Type Description
Project ID
id integer

Project id

Project name
name string

Project name

Consultable?
consultable boolean

TRUE if the project if consultable

Verdict of the project
verdict string

Verdict of the project (won/lost/na)

Template?
is_template boolean

TRUE if this project will be used as a template

Downloadable?
can_be_downloaded boolean

TRUE if the documents can be downloaded

Project preview URL
preview_new string
Duration (for templates only)
duration string

Used only for templates, you can create projects from this template that will expire xx days later.

Starred?
starred boolean

TRUE if is a starred project

External Id
external_id string

Project external_id

Project authentication url
url string

Project authentication url

Project signed?
signed boolean

Project signed?

Project can be signed?
signable boolean

Project signable?

Tags
tags array of string

Project tags

vCard
vcard_id integer

Project vcard_id

Notification email
email_cible array of string

Project email_cible

Reading notifications?
alert_on boolean

Project alert_on

Project created_at
created_at string
Project updated_at
updated_at string
Deadline (date)
consultable_until string

Allow consultation until this date

Project last_sign_in_at
last_sign_in_at string
Project first_access_at
first_access_at string
Project collaborators_count
collaborators_count integer
Project complete_base
convert_status.complete_base boolean
Project complete_full
convert_status.complete_full boolean
Project nb_connections
nb_connections integer
Project total_time
total_time integer
id
theme.id integer

Project theme id

name
theme.name string

Project theme name

project_escape
iframes.project_escape string

Project edit

tokens_escape
iframes.tokens_escape string

Project links

stats_escape
iframes.stats_escape string

Project stats

Project tokens_count
tokens_count integer
Project items_count
project_items_count integer
Project nb_used_as_template
nb_used_as_template integer
Project email_templates_count
email_templates_count integer

List and search items

List or search for items

Parameters

Name Key Required Type Description
Limit
limit True integer

number of results

Offset
offset True integer

Offset

Tag(s)
tags string

Add tags (coma separated) to search items

tagOperator
tagOperator string

Use AND (default) to retrieve items with all tags, OR to retrieve items with any of the provided tags

Search text
search string

Search for any text in document's name

Returns

Name Path Type Description
Searched string
search string
Limit
limit integer
Offset
offset integer
Order
order string
contents
contents array of object
ID
contents.id integer
Title
contents.title string
Usable?
contents.usable boolean
Element type
contents.element_type string
Extension
contents.extension string
Type
contents.type string
External id
contents.external_id string
Tags
contents.tags array of string
Favorite?
contents.favorite boolean
Version
contents.file_version integer
Number of pages
contents.num_pages integer
Visible?
contents.visible boolean
Thumbnail URL
contents.thumbnail_url string
Created at
contents.created_at string
Updated at
contents.updated_at string
Ueplaced at
contents.replaced_at string
URL
contents.s3_url string
Content URL
contents.content_url string
Complete base
contents.convert_status.complete_base boolean
Complete full
contents.convert_status.complete_full boolean
Status
contents.convert_status.status array of string
First name
contents.owner.first_name string
Last name
contents.owner.last_name string
ID
contents.owner.id integer
Email
contents.owner.email string
Avatar
contents.owner.avatar string
Projects
contents.projects array of object
ID
contents.projects.id integer
Name
contents.projects.name string
Template?
contents.projects.is_template boolean
Number of projects
contents.projects_count integer
Content
contents.content string
Thumbnail page url
contents.thumbnail_page_url string

List and search projects or templates

List or search for project or template

Parameters

Name Key Required Type Description
Limit
limit True integer

number of results

Offset
offset True integer

offset

Order
order True string

Sorting order (-created_at to order by creation date desc)

Templates only
is_template True boolean

TRUE to retrieve only templates

Tag(s)
tags string

Add tags (coma separated) to search projects by tag

tagOperator
tagOperator string

Use AND (default) to retrieve projects with all tags, OR to retrieve projects with any of the provided tags

My projects ony
is_owner True boolean

TRUE to retrieve only my projects (no projects from other users)

Search text
search string

Search for any text in project's or link's name

Returns

Name Path Type Description
Searched string
search string
Limit
limit integer
Offset
offset integer
Total
total integer
Order
order string
Project
contents array of object

Project

id
contents.id integer
name
contents.name string
verdict
contents.verdict string
template?
contents.is_template boolean
can be downloaded?
contents.can_be_downloaded boolean
preview url
contents.preview_new string
duration
contents.duration string
starred?
contents.starred boolean
external id
contents.external_id string
authentication url
contents.url string
signed?
contents.signed boolean
signable?
contents.signable boolean
consultable?
contents.consultable boolean
tags
contents.tags array of string
pt note
contents.pt_note float
pt accuracy
contents.pt_accuracy string
pt won
contents.pt_won boolean
vcard id
contents.vcard_id integer
email cible
contents.email_cible array of string
alert?
contents.alert_on boolean
created at
contents.created_at string
updated at
contents.updated_at string
consultable until
contents.consultable_until string
last sign in at
contents.last_sign_in_at string
first access at
contents.first_access_at string
collaborators
contents.collaborators_count integer
complete base
contents.convert_status.complete_base boolean
complete full
contents.convert_status.complete_full boolean
nb connections
contents.nb_connections integer
total time
contents.total_time integer
leader first name
contents.leader_first_name string
leader last name
contents.leader_last_name string
leader id
contents.leader_id integer
leader email
contents.leader_email string
leader avatar
contents.leader_avatar string
nb tokens
contents.tokens_count integer
nb project items
contents.project_items_count integer
nb used as template
contents.nb_used_as_template integer
email templates count
contents.email_templates_count integer
can edit
contents.can_edit boolean

Update a project (verdict, consultable, downloadable...)

Update a project (verdict, consultable, downloadable...)

Parameters

Name Key Required Type Description
Project id
id True string

Tilkee internal id of the project to update

Project name
name string

Project name

Downloadable?
can_be_downloaded boolean

TRUE if the documents can be downloaded

Consultable?
consultable boolean

TRUE if the project if consultable

Deadline (date)
consultable_until string

Allow consultation until this date

Duration (for templates only)
duration string

Used only for templates, you can create projects from this template that will expire xx days later.

External Id
external_id string

external_id

Starred?
starred boolean

TRUE if is a starred project

Tags
Tags string
Verdict of the project
verdict string

Verdict of the project (won/lost/na)

Collaborators (Ids)
Collaborators (Ids)
Template?
is_template boolean

TRUE if this project will be used as a template

vCard
vcard_id integer

ID of the vCard to be displayed

Reading alerts?
alert_on boolean

Enable reading alerts

Notification email
Notification email string
id
id integer

theme id

Returns

Name Path Type Description
Project ID
id integer

Project id

Project name
name string

Project name

Consultable?
consultable boolean

TRUE if the project if consultable

Verdict of the project
verdict string

Verdict of the project (won/lost/na)

Template?
is_template boolean

TRUE if this project will be used as a template

Downloadable?
can_be_downloaded boolean

TRUE if the documents can be downloaded

Project preview URL
preview_new string
Duration (for templates only)
duration string

Used only for templates, you can create projects from this template that will expire xx days later.

Starred?
starred boolean

TRUE if is a starred project

External Id
external_id string

Project external_id

Project authentication url
url string

Project authentication url

Project signed?
signed boolean

Project signed?

Project can be signed?
signable boolean

Project signable?

Tags
tags array of string

Project tags

vCard
vcard_id integer

Project vcard_id

Notification email
email_cible array of string

Project email_cible

Reading notifications?
alert_on boolean

Project alert_on

Project created_at
created_at string
Project updated_at
updated_at string
Deadline (date)
consultable_until string

Allow consultation until this date

Project last_sign_in_at
last_sign_in_at string
Project first_access_at
first_access_at string
Project collaborators_count
collaborators_count integer
Project complete_base
convert_status.complete_base boolean
Project complete_full
convert_status.complete_full boolean
Project nb_connections
nb_connections integer
Project total_time
total_time integer
id
theme.id integer

Project theme id

name
theme.name string

Project theme name

Project tokens_count
tokens_count integer
Project items_count
project_items_count integer
Project nb_used_as_template
nb_used_as_template integer
Project email_templates_count
email_templates_count integer

Upload information

Retrieve S3 upload information to upload file in Tilkee's platform. After retrieving this info, you should POST your file to 's3_endpoint, with key, acl, policy, signature & AWSAccessKeyId parameters. Amazon’s response is the URL you need to create your item in Tilkee.

Parameters

Name Key Required Type Description
Filename with extension
filename True string

Filename, with extension

Filename without extension
original_filename True string

Filename, without extension

Check if file exists
check_existing boolean

Check existing files with same name?

Returns

Name Path Type Description
Direct Upload key
key string
Direct Upload acl
acl string
Direct Upload policy
policy string
Direct Upload signature
signature string
Direct Upload AWSAccessKeyId
AWSAccessKeyId string
Direct Upload success_action_status
success_action_status string
Direct Upload endpoint
s3_endpoint string
File name
name string

Triggers

Subscribe to a Tilkee event

Trigger your Flow when this event is triggered in Tilkee

Subscribe to end of connexion Tilkee event

Trigger your flow after connexion on a Tilkee project

Subscribe to signature Tilkee event

Trigger your flow when a Tilkee project is signed

Subscribe to a Tilkee event

Trigger your Flow when this event is triggered in Tilkee

Parameters

Name Key Required Type Description
Notification triggers
rule True string

Any of connexion_started, connexion_ended, token_signed, token_created, project_archived, unactivated_project_accessed, user_created

User ID
user_id string

Only send notifications for this user's projects

Project ID
project_id string

Only send notifications for this projects

Returns

Name Path Type Description
link.id
token.id integer

Link id

link.url
token.url string

Link URL

link.verdict
token.won string

Link verdict

link.name
token.name string

Link name

link.Signed
token.signed boolean

Link Signed?

link.interest
token.interest float

Link interest

link.created_at
token.created_at string

Link created_at

link.creator_id
token.creator_id integer

Link creator_id

link.downloaded
token.downloaded boolean

Link downloaded?

link.total_time
token.total_time integer

Link total_time

link.archived_at
token.archived_at string

Link archived_at

link.external_id
token.external_id string

Link external_id

link.hot_prospect
token.hot_prospect boolean

Link hot_prospect?

link.cc_recipients
token.cc_recipients string

Link cc_recipients

link.external_data
token.external_data string

Link external_data

link.signed_status
token.signed_status string

Link signed_status

link.first_access_at
token.first_access_at string

Link first_access_at

link.connections_count
token.connections_count integer

Link connections_count

link.most_visited_time
token.most_visited_time integer

Link most_visited_time

link.most_visited_title
token.most_visited_title string

Link most_visited_title

project.id
project.id integer

Project id

project.url
project.url string

Project url

project.name
project.name string

Project name

project.tags
project.tags array of string

Project tags

project.leader_id
project.leader.id integer

Project leader id

project.leader_last_name
project.leader.last_name string

Project leader last_name

project.leader_first_name
project.leader.first_name string

Project leader first_name

project.signed
project.signed boolean

Project signed?

project.avg_time
project.avg_time integer

Project avg_time

project.interest
project.interest float

Project interest

project.owner_id
project.owner_id integer

Project owner_id

project.created_at
project.created_at string

Project created_at

project.downloaded
project.downloaded boolean

Project downloaded

project.total_time
project.total_time integer

Project total_time

project.archived_at
project.archived_at string

Project archived_at

project.external_id
project.external_id string

Project external_id

project.owner_email
project.owner_email string

Project owner_email

project.platform_ids
project.platform_ids integer

Project platform_ids

project.connexion_count
project.connexion_count integer

Project connexion_count

project.first_access_at
project.first_access_at string

Project first_access_at

project.most_visited_time
project.most_visited_time string

Project most_visited_time

project.most_visited_title
project.most_visited_title string

Project most_visited_title

project.median_percentage_read
project.median_percentage_read float

Project median_percentage_read

connexion.id
connexion.id integer

Connexion id

connexion.title
connexion.title string

Connexion title

connexion.signed
connexion.signed boolean

Connexion signed?

connexion.created_at
connexion.created_at string

Connexion created_at

connexion.downloaded
connexion.downloaded boolean

Connexion downloaded?

connexion.new_person
connexion.new_person boolean

Connexion new_person?

connexion.total_time
connexion.total_time integer

Connexion total_time

connexion.user_agent
connexion.user_agent string

Connexion user_agent

connexion.access_date
connexion.access_date string

Connexion access_date

connexion.platform_id
connexion.platform_id integer

Connexion platform_id

connexion.percentage_read
connexion.percentage_read integer

Connexion percentage_read

connexion.most_visited_time
connexion.most_visited_time integer

Connexion most_visited_time

connexion.most_visited_title
connexion.most_visited_title string

Connexion most_visited_title

Product title
product_title string
Event name
event string

Subscribe to end of connexion Tilkee event

Trigger your flow after connexion on a Tilkee project

Parameters

Name Key Required Type Description
User ID
user_id string

Only send notifications for this user's projects

Project ID
project_id string

Only send notifications for this projects

Returns

Name Path Type Description
link.id
token.id integer

Link id

link.url
token.url string

Link URL

link.verdict
token.won string

Link verdict

link.name
token.name string

Link name

link.Signed
token.signed boolean

Link Signed?

link.interest
token.interest float

Link interest

link.created_at
token.created_at string

Link created_at

link.creator_id
token.creator_id integer

Link creator_id

link.downloaded
token.downloaded boolean

Link downloaded?

link.total_time
token.total_time integer

Link total_time

link.archived_at
token.archived_at string

Link archived_at

link.external_id
token.external_id string

Link external_id

link.hot_prospect
token.hot_prospect boolean

Link hot_prospect?

link.cc_recipients
token.cc_recipients string

Link cc_recipients

link.external_data
token.external_data string

Link external_data

link.signed_status
token.signed_status string

Link signed_status

link.first_access_at
token.first_access_at string

Link first_access_at

link.connections_count
token.connections_count integer

Link connections_count

link.most_visited_time
token.most_visited_time integer

Link most_visited_time

link.most_visited_title
token.most_visited_title string

Link most_visited_title

project.id
project.id integer

Project id

project.url
project.url string

Project url

project.name
project.name string

Project name

project.tags
project.tags array of string

Project tags

project.leader_id
project.leader.id integer

Project leader id

project.leader_last_name
project.leader.last_name string

Project leader last_name

project.leader_first_name
project.leader.first_name string

Project leader first_name

project.signed
project.signed boolean

Project signed?

project.avg_time
project.avg_time integer

Project avg_time

project.interest
project.interest float

Project interest

project.owner_id
project.owner_id integer

Project owner_id

project.created_at
project.created_at string

Project created_at

project.downloaded
project.downloaded boolean

Project downloaded

project.total_time
project.total_time integer

Project total_time

project.archived_at
project.archived_at string

Project archived_at

project.external_id
project.external_id string

Project external_id

project.owner_email
project.owner_email string

Project owner_email

project.platform_ids
project.platform_ids integer

Project platform_ids

project.connexion_count
project.connexion_count integer

Project connexion_count

project.first_access_at
project.first_access_at string

Project first_access_at

project.most_visited_time
project.most_visited_time string

Project most_visited_time

project.most_visited_title
project.most_visited_title string

Project most_visited_title

project.median_percentage_read
project.median_percentage_read float

Project median_percentage_read

connexion.id
connexion.id integer

Connexion id

connexion.title
connexion.title string

Connexion title

connexion.signed
connexion.signed boolean

Connexion signed?

connexion.created_at
connexion.created_at string

Connexion created_at

connexion.downloaded
connexion.downloaded boolean

Connexion downloaded?

connexion.new_person
connexion.new_person boolean

Connexion new_person?

connexion.total_time
connexion.total_time integer

Connexion total_time

connexion.user_agent
connexion.user_agent string

Connexion user_agent

connexion.access_date
connexion.access_date string

Connexion access_date

connexion.platform_id
connexion.platform_id integer

Connexion platform_id

connexion.percentage_read
connexion.percentage_read integer

Connexion percentage_read

connexion.most_visited_time
connexion.most_visited_time integer

Connexion most_visited_time

connexion.most_visited_title
connexion.most_visited_title string

Connexion most_visited_title

Product title
product_title string
Event name
event string

Subscribe to signature Tilkee event

Trigger your flow when a Tilkee project is signed

Parameters

Name Key Required Type Description
User ID
user_id string

Only send notifications for this user's projects

Project ID
project_id string

Only send notifications for this projects

Returns

Name Path Type Description
link.id
token.id integer

Link id

link.url
token.url string

Link URL

link.name
token.name string

Link name

link.created_at
token.created_at string

Link created_at

link.external_id
token.external_id string

Link external_id

link.external_data
token.external_data string

Link external_data

project.id
project.id integer

Project id

project.url
project.url string

Project url

project.name
project.name string

Project name

project.tags
project.tags array of string

Project tags

project.leader_id
project.leader.id integer

Project leader id

project.leader_last_name
project.leader.last_name string

Project leader last_name

project.leader_first_name
project.leader.first_name string

Project leader first_name

project.external_id
project.external_id string

Project external_id

sign.connexion_success_id
sign.connexion_success_id integer

Connexion success id

sign.phone
sign.phone string

Phone

sign.mail
sign.mail string

Mail

sign.last_name
sign.last_name string

last_name

sign.first_name
sign.first_name string

first_name

sign.status
sign.status string

Status

sign.signed_docs
sign.signed_docs array of object

Signed docs

Name
sign.signed_docs.name string
URL
sign.signed_docs.url string
Product title
product_title string
Event name
event string