How to use IBM App Connect with Microsoft OneNote
Microsoft OneNote is a digital notebook that is designed to collect information and organize notes freely, making it a useful tool for organizing ideas and effectively collaborating with people in real time.
- App Connect Enterprise as a Service connector
-
Local connector in containers (Continuous Delivery release) 12.0.9.0-r2 or later
-
Local connector in containers (Long Term Support Cycle-2 release)
Connecting to Microsoft OneNote
Complete the connection fields that you see in the App Connect Designer page (previously the Catalog page) or flow editor. If necessary, work with your Microsoft OneNote administrator to obtain these values.
Microsoft OneNote connection fields:
Authorization method | Connection field | Applicability |
---|---|---|
BASIC OAUTH | Application client ID | App Connect Enterprise as a Service and App Connect in containers |
Application client secret | ||
Access token | ||
Refresh token | ||
OAUTH 2.0 PASSWORD | Username | App Connect Enterprise as a Service and App Connect in containers |
Password | ||
Application client ID | ||
Application client secret | ||
OAUTH 2.0 AUTH CODE |
Tip: Authorize connection to Microsoft OneNote by signing
in to your account.
|
App Connect Enterprise as a Service |
Connection field | Description |
---|---|
Application client ID | The unique identifier generated after the Microsoft Azure app registration gets mapped to the specific project requests. |
Application client secret | The application client secret for a project-specific unique application client ID. |
Access token | The access token that is generated from the application client ID and client secret. |
Refresh token | The refresh token that is generated from the application client ID and client secret. |
Username | The username that is authorized to access the Microsoft OneNote API. |
Password | The password for the specified username. |
To obtain the connection values for Microsoft OneNote, see Obtaining connection values for Microsoft OneNote.
To connect to a Microsoft OneNote endpoint from the App Connect Designer Applications and APIs page for the first time, expand Microsoft OneNote, then click Connect. For more information, see Managing accounts.
Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Applications and APIs page, select the account, open its options menu (⋮), then click Rename Account.
General considerations
Before you use App Connect Designer with Microsoft OneNote, take note of the following considerations:
- The following table describes the service limits for the Microsoft OneNote connector:
For more information about service limits, see OneNote service limits on the Microsoft Documentation page.
Limit type Limit per app per user (delegated context) Limit per app (app-only context) Requests rate 120 requests per 1 minute and 400 per 1 hour 240 requests per 1 minute and 800 per 1 hour Concurrent requests 5 concurrent requests 20 concurrent requests - All the supported actions in the Microsoft OneNote connector has
User ID as an input field.
- If you want to execute an action for your own notebook, then you have to provide 'me' as the input value.
- If you want to execute an action on behalf of other users who have permitted you, then you must provide the user ID of the other user as the input value.
- Example of App Connect user interface fields that are filled for the action Create
page with embedded content:In the example, you can see that the Content field contains information about the HTML content which consists of a file attachment. You can configure this field to include multiple images and file attachments. For more information about configuring this field, see the following useful resources on the Microsoft Documentation page.Restriction: For a list of limitations while sending image and file data, see Size limitations for POST pages requests on the Microsoft Documentation page.
- (General consideration) You can see lists of the trigger events and
actions that are available on the Applications and APIs page of the App Connect Designer.
For some applications, the events and actions depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.
- (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.
Events and actions
Microsoft OneNote events
These events are for changes in this application that trigger a flow to start completing the actions in the flow.
Microsoft OneNote actions
Your flow completes these actions on this application.
Object | Action | Description |
---|---|---|
Pages | Create page with embedded content | Creates a page with embedded content in OneNote Tip: For more information about
using the Create page with embedded content operation, see Add images, videos, and files to OneNote pages on the Microsoft
Documentation page.
|
Create page | Creates a page in OneNote | |
Retrieve pages | Retrieves pages from OneNote | |
Delete page | Deletes a page from OneNote | |
Download page content | Downloads the page content | |
Append note | Appends a note in OneNote page | |
Notebooks | Create notebook | Creates a notebook in OneNote |
Retrieve notebooks | Retrieves the notebooks from OneNote | |
Retrieve recent notebooks | Retrieves the recent notebooks from OneNote | |
Sections | Create section | Creates a section in OneNote page |
Retrieve sections | Retrieves the sections from OneNote pages | |
Section groups | Create section group | Creates the section group in OneNote page |
Retrieve section groups | Retrieves the section groups from OneNote page |
Examples



Use templates to quickly create flows for Microsoft OneNote
Learn how to use App Connect templates to quickly create flows that complete actions on Microsoft OneNote. For example, open the Templates gallery, and then search for Microsoft OneNote.


Use IBM® App Connect to build flows that integrate with Microsoft OneNote.
Read the blog in the IBM Community to learn how to create a page with embedded content for each new email received with attachments from Microsoft Exchange. Click Read the blog to go to the blog.