Outline
The Outline modules allow you to watch, create, update, list, search, retrieve, archive, restore, and delete the documents from your Outline account.
Getting Started with Outline
Prerequisites
- An Outline account - create an account at getoutline.com.
The module dialog fields that are displayed in bold (in the Integromat scenario, not in this documentation article) are mandatory!
Connecting Outline to Integromat
To connect your Outline account to Integromat you need to obtain the API key from your Outline account and insert it in the Create a connection dialog in the Integromat module.
1. Log in to your Outline account.
2. Click Settings.
3. Click API Tokens.
4. Click New token...
5. In the Name field, enter a name for the token and click Create.
6. Copy the API Token to your clipboard.
7. Log in to your Integromat account, add a module from the Outline app into an Integromat scenario.
8. Click Add next to the Connection field.
9. In the Connection name field, enter a name for the connection.
10. In the API Key field, enter the token details copied in step 6 and click Continue.
The connection has been established.
Documents
Watch New Document
Triggers when a new document is published.
Connection | Establish a connection to your Outline account. |
Limit | Set the maximum number of documents Integromat should return during one execution cycle. Note the default limit is 10. |
List All Published Documents
Lists all published documents and draft documents belonging to the current user.
Connection | Establish a connection to your Outline account. |
Limit | Set the maximum number of documents Integromat should return during one execution cycle. The default value is 10. |
Sort | Enter (map) the option to sort the documents. For example, Document Name. |
Direction | Select or map the order in which you want to list the documents:
|
Collection ID | Select or map the Collection ID of the documents you want to list. |
User ID | Select or map the User ID of the person whose documents you want to list. |
Backlink Document ID | Enter (map) the Backlink Document ID of the document you want to list |
Parent Document ID | Select or map the Parent Document ID of the documents you want to list. |
Template | Select whether the template is required or not. This field is required when listing the templates alone. |
List All Draft Documents
Lists all draft documents belonging to the current use
Connection | Establish a connection to your Outline account. |
Limit | Set the maximum number of documents Integromat should return during one execution cycle. Note the default limit is 10. |
Sort | Enter (map) the option to sort the documents. For example, Document Name. |
Direction | Select or map the order in which you want to list the documents:
|
Collection ID | Select or map the Collection ID of the draft documents you want to list. |
Date Filter | Select the required date filter:
|
Search All Documents
Searches your team's documents with keywords.
Connection | Establish a connection to your Outline account. |
Query | Enter (map) a keyword or phrase to search the documents that match the specified query. |
User ID | Select or map the User ID whose documents you want to search. |
Collection ID | Select or map the Collection ID of the draft documents you want to list. |
Include Archived | Select whether you want to include the archived documents in your search results. |
Include Drafts | Select whether you want to include the draft documents in your search results. |
Date Filter | Select or map the required date filter:
|
Limit | Set the maximum number of documents Integromat should return during one execution cycle. The default value is 10. |
Get a Document
Retrieves a document by its id.
Connection | Establish a connection to your Outline account. |
Collection ID | Select or map the Collection ID of the document whose details you want to retrieve. |
Share ID | Select or map the Share ID of the document whose details you want to retrieve. |
Create a Document
Creates or publishes a new document.
Connection | Establish a connection to your Outline account. |
Title | Enter (map) the name of the document you want to create or publish. |
Collection ID | Select or map the Collection ID of the document you want to create. |
Text | Enter (map) the document text. |
Parent Document ID | Select or map the Parent Document ID of the document you want to create. |
Template ID | Select or map the Template ID of the document you want to create. |
Template | Select whether you want to consider this document as a template. |
Publish | Select whether you want to publish this document immediately and should be visible to other team members. |
Update a Document
Modifies an existing document.
Connection | Establish a connection to your Outline account. |
Document ID | Select or map the Document ID of the document to be updated. |
Title | Enter (map) a new name for the document. |
Text | Enter the text to add inside the document. |
Append | Select whether you want to display the text field at the end of the existing document instead of replacing it. |
Publish | select whether you want to publish this document and make it visible to other team members as a draft. |
Done | Select whether you have finished editing the document. This action might trigger notifications to other members. |
Archive a Document
Allows outdated information to be moved out of sight and restore it later, if needed.
Connection | Establish a connection to your Outline account. |
Document ID | Select or map the Document ID you want to archive. |
Restore an Archived Document
Restores an archived document.
Connection | Establish a connection to your Outline account. |
Document ID | Select or map the archived Document ID you want to restore. |
Restore a Deleted Document
Restores a deleted document.
Connection | Establish a connection to your Outline account. |
Document ID | Select or map the deleted Document ID you want to restore. |
Deleted a Document
Moves a document to the trash. If not restored within 30 days it is permanently deleted.
Connection | Establish a connection to your Outline account. |
Document ID | Select or map the Document ID you want to delete. |
Others
Make an API Call
Performs an arbitrary authorized API Call.
Connection | Establish a connection to your Outline account. |
URL | Enter a path relative to For the list of available endpoints, refer to the Outline API Documentation. |
Method | Select the HTTP method you want to use: GET POST PUT PATCH DELETE |
Headers | Enter the desired request headers. You don't have to add authorization headers; we already did that for you. |
Query String | Enter the request query string. |
Body | Enter the body content for your API call. |
Example of Use - Search All Documents
The following API call returns all the documents from your Outline account:
URL:/documents.search
Method:POST
Matches of the search can be found in the module's Output under Bundle > Body > data.
In our example, 10 documents were returned: