Microsoft Word Toolkit

The Microsoft Word Toolkit is a workflow node. Its tools include List Documents, Create Document, Read Document, and Write Content, plus 7 more listed below. Connect a Microsoft Word account before you use any of these tools. Type @ in a field when the value should come from an earlier step.

Authentication

Every Microsoft Word tool needs a connected account before it can run. On the node, open Microsoft Word Account.

1. Choose Use my Microsoft Word account or Use team account.
2. If no personal account is connected, click Connect Microsoft Word Account and finish sign-in.
3. For a team account, choose Use team account and pick one from Team account. The list shows accounts already connected for the project.

Tools

List Documents

Lists documents.

Field	Required	Description
Microsoft Word Account	Yes	Select your personal or team Microsoft Word account.
Search Query	No	Optional search query to filter documents. Default is null. Type @ to select a variable.

Create Document

Creates document.

Field	Required	Description
Microsoft Word Account	Yes	Select your personal or team Microsoft Word account.
Document Name	Yes	Name for the new Word document. Type @ to select a variable.
Initial Content	No	Optional initial content for the document. Default is null. Type @ to select a variable.

Read Document

Reads document.

Field	Required	Description
Microsoft Word Account	Yes	Select your personal or team Microsoft Word account.
File ID	Yes	The ID of the Word document to read. Type @ to select a variable.

Write Content

Runs the write content tool.

Field	Required	Description
Microsoft Word Account	Yes	Select your personal or team Microsoft Word account.
File ID	Yes	The ID of the Word document. Type @ to select a variable.
Content	Yes	Content to write to the document. Type @ to select a variable.
Position	No	Position to insert content: 'start', 'end', or 'replace'. Default is end. Type @ to select a variable.

Insert Text

Runs the insert text tool.

Field	Required	Description
Microsoft Word Account	Yes	Select your personal or team Microsoft Word account.
File ID	Yes	The ID of the Word document. Type @ to select a variable.
Text	Yes	Text to insert. Type @ to select a variable.
Location	No	Location to insert text. Default is end. Type @ to select a variable.

Replace Text

Runs the replace text tool.

Field	Required	Description
Microsoft Word Account	Yes	Select your personal or team Microsoft Word account.
File ID	Yes	The ID of the Word document. Type @ to select a variable.
Search Text	Yes	Text to search for and replace. Type @ to select a variable.
Replacement Text	Yes	Text to replace with. Type @ to select a variable.

Insert Table

Runs the insert table tool.

Field	Required	Description
Microsoft Word Account	Yes	Select your personal or team Microsoft Word account.
File ID	Yes	The ID of the Word document. Type @ to select a variable.
Rows	Yes	Number of rows in the table. Type @ to select a variable.
Columns	Yes	Number of columns in the table. Type @ to select a variable.
Table Data	No	Optional data to populate the table. Default is null.

Format Text

Runs the format text tool.

Field	Required	Description
Microsoft Word Account	Yes	Select your personal or team Microsoft Word account.
File ID	Yes	The ID of the Word document. Type @ to select a variable.
Text Range	Yes	Text range to format. Type @ to select a variable.
Formatting	Yes	Formatting options (bold, italic, font, etc.). Type @ to select a variable.

Insert Image

Runs the insert image tool.

Field	Required	Description
Microsoft Word Account	Yes	Select your personal or team Microsoft Word account.
File ID	Yes	The ID of the Word document. Type @ to select a variable.
Image URL	Yes	URL of the image to insert. Type @ to select a variable.
Alt Text	No	Alternative text for the image. Default is null. Type @ to select a variable.

Save Document

Runs the save document tool.

Field	Required	Description
Microsoft Word Account	Yes	Select your personal or team Microsoft Word account.
File ID	Yes	The ID of the Word document to save. Type @ to select a variable.

Export Document

Runs the export document tool.

Field	Required	Description
Microsoft Word Account	Yes	Select your personal or team Microsoft Word account.
File ID	Yes	The ID of the Word document. Type @ to select a variable.
Export Format	Yes	Export format: 'pdf', 'html', 'txt'. Type @ to select a variable.

Related

Agents can use this integration from chat. See Microsoft Word.

See all integrations on the toolkits overview.