About the Outlook category

[o.plokha]

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: Outlook API Reference

Connector package documentation

​​Table of Contents

• 1. Setting up HTTP Client Outlook
  • 1.1 Steps
• 2. Subscribing to entities from Outlook
  • 2.1 Steps
  • 2.2 General concept
• 3. Publishing entity to Outlook
  • 3.1 Steps
  • 3.2 General concept

1. Setting up HTTP Client Outlook

1.1 Steps

1. In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
2. Select Outlook HTTP Client as PlatForm and click next step
3. Fill in the Token URL, Authorize URL, Client ID, Client Secret and Scopes.
   (See the Outlook Authentication Documentation for more information)
4. Click on “Grant access to Outlook” and you will be redirected to Microsoft Authentication to get the key for the client.
5. You can optionally enable logging of request to get the log of the authentication.
6. Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use.

2. Subscribing to Entities from Outlook

2.1 Steps

1. Go to Connections → Incoming and create a new incoming configuration and select “Outlook Subscriber” as the subscriber.
2. Select the Method that you want the subscriber to fetch the data.
3. Select the entity you want to subscribe to from Outlook.
4. Add any request parameters needed to subscribe to the entity.
5. Select the Outlook HTTP Client to use.
6. You can optionally add a transformer to transform the request parameters into something you will request from Outlook.
7. You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept

We follow Outlook documentation on building this connector, so you can easily use the connector based on Outlook API Reference.

Entity

The entity you want to subscribe to Outlook. Please refer to the entities from Outlook API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the Outlook API Reference.

Please look at the example below on how to fill path field when we want retrieve an email by subscribing “Mail - Get a message” entity.

From the end point, we can see that we need to set the message id as parameters. That is why we set the “MessageId” inside the path key in the Request Parameters.

Alumio will then make a request to Outlook with the URL https://graph.microsoft.com/v1.0/me/messages/123

• Path is the path parameter of the url. For example the {id}.
• Query is defined set of parameters attached to the end of a url.
  Example: www.url.com?type=true&start=0
• Payload is the data contained within a request.

HTTP Client

The HTTP Client configuration you will use to access Outlook.

3. Publishing Entity to Outlook

3.1 Steps

1. Go to Connections → Outgoing, create a new outgoing configuration and select “Outlook Publisher” as the publisher.
2. Select the Method that you want the publisher to perform with the data.
3. Select the Outlook entity you want the data to be published to.
4. You can optionally add any query data to the request on the key query.
5. You can optionally add any payload data to the request on the key payload.
6. Select the HTTP Client to use.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer.

Method

Currently, we support HTTP Post method, HTTP Patch method and HTTP Delete method on submitting data to Outlook.

Entity

We support publishing to most Outlook endpoints.
Please refer to Outlook API Reference page.

For example, we want to send an email. Please select “Post” as the Method and “Mail - Send mail”.

From the documentation, we can see that we need to set a body parameters. That is why we set the body parameters inside the payload key in the data.

Alumio will send an API request to Outlook with URL https://graph.microsoft.com/v1.0/me/sendMail

• Path is the path parameter of the url. For example the {id}.
• Query is defined set of parameters attached to the end of a url.
  Example: www.url.com?type=true&start=0
• Payload is the data contained within a request.

HTTP Client

The HTTP Client configuration you will use to access Outlook.