This topic explains how to obtain the required identifiers and
assemble a Microsoft Teams deep link that opens Automation Co-Pilot directly to a specific request inside Microsoft Teams.
Before you begin
To build a working deep link, you need
- App ID
- The Microsoft Teams app’s ID (sometimes referred to
as the Microsoft App ID in the Teams application configuration).
- Entity ID
- The identifier of the Personal tab (the tab you want
to open inside Microsoft Teams).
- Request ID
- The Automation Co-Pilot request reference that you want the link
to open.
Procedure
-
Create or open your Teams app (App ID).
-
Open Microsoft Teams Developer Portal.
-
Select Apps.
If you already have an application for Automation Co-Pilot open it. Otherwise select
Create a new app and enter the required
details such as name, description, developer information.
-
Copy the App ID shown for the app (this is used
in the deep link URL).
You obtained an
App ID.
For example,
https://teams.microsoft.com/l/app/96bfc9ea-ffac-410d-96ca-df449bl83cl3?source=manage-apps-copy-link
Here,
96bfc9ea-ffac-410d-96ca-df449bl83cl3 (part after
app/ is the
App
ID.
<APP_ID> is created.
-
Configure a Personal tab and capture the
Entity ID.
-
In the same app within Teams Developer Portal,
go to App features.
-
Locate Personal app (or
Personal tab depending on the portal
view).
-
Add a Personal tab (or edit if you already have)
and enter the following details, for example:
- Name: Automation Co-Pilot
- Content URL: the web URL your tab loads
(provided by your Automation Co-Pilot setup)
- Website URL (optional but recommended): a
browser-friendly URL
-
Save the configuration.
-
Copy the Entity ID for that
Personal tab.
You obtained an Entity ID. For example,
0eff0783-9304-4daa -9f6e-dfe0e8d0cfb3
-
Get the Request ID (Automation Co-Pilot).
You can use one of the following methods to capture the Request
ID that represents the request you want the deep link to
open.
- Copy from the request page
- Open Automation Co-Pilot and navigate to the
request.
- Copy the request reference from the UI (for example, Request
Ref),
or
- Copy it from the URL if the request reference appears in the
route.
Typical formats seen in routes are
requests/ref/<REQUEST_ID>. For example,
requests/ref/62-152
- Copy from a notification payload (if applicable)
If your process sends
a message or notification containing a request reference, copy the
request reference directly from that payload.
You obtained the Request ID. For example,
requests/ref/62-152
-
Build the deep link.
Teams
Personal tab deep link uses this
format:
https://teams.microsoft.com/l/entity/<APP_ID>/<ENTITY_ID>?<DEEP_LINK_PARAMETER>
To open a specific request inside the tab, pass a Teams
context parameter with a subEntityId
pointing to the request route. To build the deep link,
-
Define the sub-entity route as
subEntityId =
"requests/ref/<REQUEST_ID>". For example,
requests/ref/62-152.
-
Create the context JSON as
{"subEntityId":"requests/ref/<REQUEST_ID>"}.
-
URL-encode the context parameter.
Teams expects the query string to be encoded. The parameter is
typically context=<JSON>. For example,
(before encoding):
context={"subEntityId":"requests/ref/62-152"}.
URL-encode this entire value and append it after
?.
-
Final example deep link (template) is
https://teams.microsoft.com/l/entity/<APP_ID>/<ENTITY_ID>?<URL_ENCODED_CONTEXT>
where <URL_ENCODED_CONTEXT> is the encoded form
of:
context={"subEntityId":"requests/ref/<REQUEST_ID>"}
-
Test the deep link in Microsoft Teams.
-
Paste the deep link into a Teams chat or channel
message.
-
Select the link.
Teams opens the Automation Co-Pilot app tab and navigates
directly to the intended request.