Build seamless automations to boost productivity with Microsoft Graph, Event Hubs and Logic Apps

Every day millions of people spend their precious time in productivity tools. What if you use data and intelligence behind the Microsoft applications (Microsoft Teams, Outlook, and many other Office apps) to build seemsless automations and custom apps to boost productivity? In this post, we’ll build a seamsless onboarding experience to new employees joining a company with the power of Microsoft Graph.

📝 What We’ll Cover

  • ✨ The power of Microsoft Graph
  • 🖇️ How do Microsoft Graph and Event Hubs work together?
  • ⚒️ Exercise: Setup Azure Event Hubs and Key Vault
  • 🪡 Exercise: Subscribe to users resource to receive change notifications by using Logic Apps
  • ♾️ Exercise: Create Onboarding workflow in the Logic Apps
  • 🚀 Debug your onboarding experience
  • 📚 Resources

Following pre-requisites are recommended:

✨ The power of Microsoft Graph

Microsoft Graph is the gateway to data and intelligence in Microsoft 365 platform. Microsoft Graph exploses Rest APIs and client libraries to access data across Microsoft 365 core services such as Calendar, Teams, To Do, Outlook, People, Planner, OneDrive, OneNote and more.

Overview of Microsoft Graph

You can build custom experiences by using Microsoft Graph such as automating the onboarding process for new employees. When new employees are created in the Azure Active Directory, they will be automatically added in the Onboarding team on Microsoft Teams.

Solution architecture

🖇️ How do Microsoft Graph and Event Hubs work together?

Microsoft Graph uses webhook mechanism to track changes in resources and deliver change notifications to the clients. As an example to the Microsoft Graph Change Notifications, you can receive change notifications when:

  • a new task is added in the to-do list
  • a user changes the presence status from busy to available
  • an event is deleted/cancelled from the calendar

If you’d like to track a large set of resources in a high frequency, you can use Azure Events Hubs instead of traditional webhooks to receive change notifications. Azure Event Hubs is a popular real-time events ingestion and distribution service built for scale.

Microsoft Graph Change Notifications can be also received by using Azure Event Grid that is currently available for Microsoft Partners. Please review the documentation for more information: Partner Events overview for customers – Azure Event Grid

⚒️ Exercise: Setup Azure Event Hubs and Key Vault

To get Microsoft Graph Change Notifications delivered to Azure Event Hubs, we’ll have to setup Azure Event Hubs and Azure Key Vault. We’ll use Azure Key Vault to access to Event Hubs connection string.

1️⃣ Create Azure Event Hubs

  1. Go to Azure Portal and select Create a resource, type Event Hubs and select click Create.
  2. Fill in the Event Hubs namespace creation details, and then click Create.
  3. Go to the newly created Event Hubs namespace page, select Event Hubs tab from the left pane and + Event Hub:
    • Name your Event Hub as Event Hub
    • Click Create.
  4. Click the name of the Event Hub, and then select Shared access policies and + Add to add a new policy:
    • Give a name to the policy
    • Check Send and Listen
    • Click Create.
  5. After the policy has been created, click the name of the policy to open the details panel, and then copy the Connection string-primary key value. Write it down; you’ll need it for the next step.
  6. Go to Consumer groups tab in the left pane and select + Consumer group, give a name for your consumer group as onboarding and select Create.

2️⃣ Create Azure Key Vault

  1. Go to Azure Portal and select Create a resource, type Key Vault and select Create.
  2. Fill in the Key Vault creation details, and then click Review + Create.
  3. Go to newly created Key Vault and select Secrets tab from the left pane and click + Generate/Import:
    • Give a name to the secret
    • For the value, paste in the connection string you generated at the Event Hubs step
    • Click Create
    • Copy the name of the secret.
  4. Select Access Policies from the left pane and + Add Access Policy:
    • For Secret permissions, select Get
    • For Principal, select Microsoft Graph Change Tracking
    • Click Add.
  5. Select Overview tab from the left pane and copy the Vault URI.

🪡 Exercise: Subscribe to users resource to receive change notifications by using Logic Apps

To start receiving Microsoft Graph Change Notifications, we’ll need to create subscription to the resource that we’d like to track. We’ll use Azure Logic Apps to create subscription.

To create subscription for Microsoft Graph Change Notifications, we’ll need to make a http post request to https://graph.microsoft.com/v1.0/subscriptions. Microsoft Graph requires Azure Active Directory authentication make API calls. First, we’ll need to register an app to Azure Active Directory, and then we will make the Microsoft Graph Subscription API call with Azure Logic Apps.

1️⃣ Create an app in Azure Active Directory

  1. In the Azure Portal, go to Azure Active Directory and select App registrations from the left pane and select + New registration. Fill in the details for the new App registration form as below:
    • Name: Graph Subscription Flow Auth
    • Supported account types: Accounts in any organizational directory (Any Azure AD directory – Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox)
    • Select Register.
  2. Go to newly registered app in Azure Active Directory, select API permissions:
    • Select + Add a permission and Microsoft Graph
    • Select Application permissions and add User.Read.All and Directory.Read.All.
    • Select Grant admin consent for the organization
  3. Select Certificates & secrets tab from the left pane, select + New client secret:
    • Choose desired expiry duration
    • Select Add
    • Copy the value of the secret.
  4. Go to Overview from the left pane, copy Application (client) ID and Directory (tenant) ID.

2️⃣ Create subscription with Azure Logic Apps

  1. Go to Azure Portal and select Create a resource, type Logic apps and select click Create.

  2. Fill in the Logic Apps creation details, and then click Create.

  3. Go to the newly created Logic Apps page, select Workflows tab from the left pane and select + Add:

    • Give a name to the new workflow as graph-subscription-flow
    • Select Stateful as a state type
    • Click Create.
  4. Go to graph-subscription-flow, and then select Designer tab.

  5. In the Choose an operation section, search for Schedule and select Recurrence as a trigger. Fill in the parameters as below:

    • Interval: 61
    • Frequency: Minute
    • Time zone: Select your own time zone
    • Start time: Set a start time
  6. Select + button in the flow and select add an action. Search for HTTP and select HTTP as an action. Fill in the parameters as below:

    {
    "changeType": "created, updated",
    "clientState": "secretClientValue",
    "expirationDateTime": "@{addHours(utcNow(), 1)}",
    "notificationUrl": "EventHub:https://<YOUR-VAULT-URI>/secrets/<YOUR-KEY-VAULT-SECRET-NAME>?tenantId=<YOUR-TENANT-ID>",
    "resource": "users"
    }
    

    In notificationUrl, make sure to replace <YOUR-VAULT-URI> with the vault uri and <YOUR-KEY-VAULT-SECRET-NAME> with the secret name that you copied from the Key Vault.

    In resource, define the resource type you’d like to track changes. For our example, we will track changes for users resource.

    • Authentication:
      • Authentication type: Active Directory OAuth
      • Authority: https://login.microsoft.com
      • Tenant: Directory (tenant) ID copied from AAD app
      • Audience: https://graph.microsoft.com
      • Client ID: Application (client) ID copied from AAD app
      • Credential Type: Secret
      • Secret: value of the secret copied from AAD app
  7. Select Save and run your workflow from the Overview tab.

Check your subscription in Graph Explorer: If you’d like to make sure that your subscription is created successfully by Logic Apps, you can go to Graph Explorer, login with your Microsoft 365 account and make GET request to https://graph.microsoft.com/v1.0/subscriptions. Your subscription should appear in the response after it’s created successfully.

Subscription workflow success

After subscription is created successfully by Logic Apps, Azure Event Hubs will receive notifications whenever there is a new user created in Azure Active Directory.

♾️ Exercise: Create Onboarding workflow in the Logic Apps

We’ll create a second workflow in the Logic Apps to receive change notifications from Event Hubs when there is a new user created in the Azure Active Directory and add new user in Onboarding team on Microsoft Teams.

  1. Go to the Logic Apps you created in the previous steps, select Workflows tab and create a new workflow by selecting + Add:

    • Give a name to the new workflow as teams-onboarding-flow
    • Select Stateful as a state type
    • Click Create.
  2. Go to teams-onboarding-flow, and then select Designer tab.

  3. In the Choose an operation section, search for Event Hub, select When events are available in Event Hub as a trigger. Setup Event Hub connection as below:

    • Create Connection:
      • Connection name: Connection
      • Authentication Type: Connection String
      • Connection String: Go to Event Hubs > Shared Access Policies > RootManageSharedAccessKey and copy Connection string–primary key
      • Select Create.
    • Parameters:
      • Event Hub Name: Event Hub
      • Consumer Group Name: onboarding
  4. Select + in the flow and add an action, search for Control and add For each as an action. Fill in For each action as below:

    • Select output from previous steps: Events
  5. Inside For each, select + in the flow and add an action, search for Data operations and select Parse JSON. Fill in Parse JSON action as below:

  6. Select + in the flow and add an action, search for Control and add For each as an action. Fill in For each action as below:

    • Select output from previous steps: value
    1. Inside For each, select + in the flow and add an action, search for Microsoft Teams and select Add a member to a team. Login with your Microsoft 365 account to create a connection and fill in Add a member to a team action as below:
    • Team: Create an Onboarding team on Microsoft Teams and select
    • A user AAD ID for the user to add to a team: id
  7. Select Save.

🚀 Debug your onboarding experience

To debug our onboarding experience, we’ll need to create a new user in Azure Active Directory and see if it’s added in Microsoft Teams Onboarding team automatically.

  1. Go to Azure Portal and select Azure Active Directory from the left pane and go to Users. Select + New user and Create new user. Fill in the details as below:

    • User name: JaneDoe
    • Name: Jane Doe

    new user in Azure Active Directory

  2. When you added Jane Doe as a new user, it should trigger the teams-onboarding-flow to run. teams onboarding flow success

  3. Once the teams-onboarding-flow runs successfully, you should be able to see Jane Doe as a member of the Onboarding team on Microsoft Teams! 🥳 new member in Onboarding team on Microsoft Teams

📚 Resources

Get your To-Do tasks every morning on Microsoft Teams using Azure Logic Apps

I am super excited since Microsoft Graph To Do APIs are introduced at Microsoft Build 2020. We finally have APIs available in public preview on the beta endpoint of Graph.

Just a brief introduction, Microsoft To Do and Planner are the essence of tasks in Microsoft 365. To-Do helps you create a list for anything, from work assignments to school projects to groceries. It is a great tool for your personal use. On the other hand, Planner is the best place to collaborate as a team and keep your team tasks. Tasks come from everywhere, you can keep track of deadlines by adding reminders, due dates, and notes.

Wouldn’t it be nice to receive your list of assigned tasks every morning on Microsoft Teams?

Today, we will build a flow using Azure Logic Apps to automate Microsoft Teams Flow bot for sending To-Do tasks every morning at 9 AM. Here is the steps we will follow:

Logic Apps Flow

Microsoft Graph To-Do APIs in Graph Explorer

To be able to review Microsoft Graph To-Do API queries and responses with your own data, go to Microsoft Graph Explorer and login with your account from the top left corner by clicking Sign in to Graph Explorer.

Then, search for “to do” under Sample queries and select Get my to do task list. This will run the query https://graph.microsoft.com/beta/me/todo/lists and will get all the task lists as a response. Copy one of your preferred task list Id from the response.

To-Do in Graph Explorer

Let’s try to get all the tasks under your preferred task list. Change the query with the following: https://graph.microsoft.com/beta/me/todo/lists/{taskListId}/tasks. Make sure the request is GET and hit Run query. You should be able to see all tasks under the selected list as a response.

Copy this query and save somewhere, we will use this later while creating a custom connector.

To-Do in Graph Explorer

Register your app in Azure Active Directory

Go to Azure Active Directory in Azure Portal. Select App Registrations and choose New registation.

Azure Active Directory App Registration

Enter To-do-flow-app in the Name field. In the Supported account types section, select Accounts in any organizational directory and personal Microsoft accounts. Leave Redirect URI blank and choose Register to continue.

Azure Active Directory App Registration

Go to API permissions from the left hand side menu and select add a permission. Choose Microsoft Graph and Delegated Permissions. Select Task.ReadWrite and click Add permission button.

Azure Active Directory App Registration

Go to Certificates & secrets from the left hand side menu and select New client secret under the Client secrets. Choose expiry time and Add.

Azure Active Directory App Registration

Copy the secret you created and Application Id under the Overview page. Save them somewhere, we will use them while creating a custom connector.

Build Azure Logic Apps Custom Connector to consume To-Do APIs in a flow

Go to Azure Portal and create Logic Apps Custom Connector.

Logic Apps Custom Connector

On the connector configuration, fill the fields as follows:

  • Subscription: Select an Azure subscription
  • Resource Group: Create new resource group
  • Custom connector name: give a name for your custom connector
  • Select the location: Region
  • Location: Select the preferred location

Choose Review + create button to continue.

Logic Apps Custom Connector

When your custom connector is successfully created, select Edit to configure your connector.

Logic Apps Custom Connector

On the connector configuration General page, fill in the fields as follows.

  • Scheme: HTTPS
  • Host: graph.microsoft.com
  • Base URL: /

Choose Security button to continue.

Logic Apps Custom Connector

On the Security page, fill in the fields as follows.

  • Choose what authentication is implemented by your API: OAuth 2.0
  • Identity Provider: Azure Active Directory
  • Client id: the application ID you created in the previous exercise
  • Client secret: the key you created in the previous exercise
  • Login url: https://login.windows.net
  • Tenant ID: common
  • Resource URL: https://graph.microsoft.com (no trailing /)
  • Scope: Leave blank

Choose Definition button to continue.

Logic Apps Custom Connector

On the Definition page, select New Action and fill in the fields as follows.

  • Summary: Get To-Do Tasks
  • Description: Get To-Do Tasks
  • Operation ID: ToDo
  • Visibility: important

Create Request by selecting Import from Sample and fill in the fields as follows.

Select Import.

Logic Apps Custom Connector

Choose Create Connector on the top-right. After the connector has been created, copy the generated Redirect URL from Security page.

Logic Apps Custom Connector

Go back to Azure Active Directory registered app, go to Authentication tab and select Add platform, choose Web.

Logic Apps Custom Connector

Paste the Redirect URI you copied from the custom connector under the Redirect URIs. Select Access tokens and Id tokens. Click Configure to continue.

Logic Apps Custom Connector

Create Logic Apps flow to automate receiving To-Do tasks

Go to Azure Portal and create Logic App.

Logic Apps Flow

On the configuration page, fill the fields as follows:

  • Subscription: Select an Azure subscription
  • Resource Group: Create new resource group
  • Custom connector name: give a name for your logic app
  • Select the location: Region
  • Location: Select the preferred location

Choose Review + create button to continue.

Logic Apps Flow

When your Logic app is successfully created, go to your Logic app and choose Logic app designer. Select Recurrence as a trigger.

Logic Apps Flow

Configure the recurrence as follows:

  • Interval: 1
  • Frequecy: Day
  • Timezone: Select the timezone you prefer
  • Start time: YYYY-MM-DDTHH:MM:SSZ
  • At these hours: 9
Logic Apps Flow

Click plus button, go to Custom and choose To-Do Connector as a next step and select Get To-Do Tasks as an action.

Logic Apps Flow

Sign in with the same account you practiced To-Do APIs in the Graph Explorer.

Logic Apps Flow

Run the flow and see if you successfully get to-do tasks by using your Get To-Do Tasks. Copy the outputs body, we will use it in the next step.

Logic Apps Flow Results

Add Parse JSON as a next step. Place Get To-Do Tasks body under the Context. Select generate schema, paste the response body you are receiving from the Get To-Do Tasks and save.

Logic Apps Flow

Add Initialize variable as a next step. Fill the field as follows:

  • Name: Tasks
  • Type: Array
  • Value: leave blank

Add For each as a next step and fill the fields as follows:

  • Output from previous steps: value from the Parse JSON step

Add Compose in For each and fill the fields as follows:

  • Inputs: title from the Parse JSON step

Add Append to array variable in For each, and fill the fields as follows:

  • Name: Tasks
  • Value: Outputs from the Compose step.
Logic Apps Flow

Run the flow and see if To-Do Json response is successfully parsed and all task titles are added in the Tasks array.

Logic Apps Flow Results
Logic Apps Flow Results

As a next step after For each, add Post a choice of options as the Flow bot to a user and fill the fields as follows:

  • Options: Tasks from the Variables step
  • Headline: Good morning!
  • Receipent: The same account you consumed the custom connector
  • Message: Here is your tasks, have a great day! :)
  • IsAlert: Yes
Logic Apps Flow

Run the flow and see check Microsoft Teams for the related account if Flow bot is sending a message. Select one of the tasks to see the results in the Logic app flow.

Note: If you didn't add Flow in your Microsoft Teams yet, here is the steps to enable Flow in your Teams account: https://cda.ms/1BB

Teams Flow Bot Results
Logic Apps Flow Results

Finally, after user selected any of the tasks to see more details, we will post another card to share more details about the selected option.

Add For each after Post a choice of options as the Flow bot to a user and fill the fields as follows:

  • Output from previous steps: value from Parse JSON step

Add Condition in For each and fill the fields as follows:

  • Condition: And
  • Choose a value: SelectedOption from the Post a choice of options as the Flow bot to a user step
  • Operation: equal to
  • Choose a value: title from Parse JSON step
    • If true: Add Post message as a Flow bot to a user in true
      • Headline: title from Parse JSON step
      • Receipent: The same account you consumed the custom connector
      • Message: importancestatuscreatedDateTime from ParseJSON step
      • IsAlert: Yes
    • If false: leave blank
Logic Apps Flow

Here is the complete flow. Run the entire flow for testing.

Logic Apps Flow

And, the following is going to be the results after selecting one of the tasks to see the details:

Teams Flow Bot Results
Logic Apps Flow Results

Our flow is completed! You can find the source code below: