Skip to content

Commit 0485c5a

Browse files
basiclinesCopilot
andcommitted
Add automation launcher link examples
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 88f15f0 commit 0485c5a

1 file changed

Lines changed: 57 additions & 1 deletion

File tree

content/copilot/how-tos/github-copilot-app/open-from-github.md

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,62 @@ https://github.com/copilot/app/launch?entry_point=docs_agent_task_link&open=ghap
8484

8585
Use the GitHub task ID for `TASK_ID`. Do not use a runtime session ID or an app-local session URL for links that resume Copilot agent tasks from {% data variables.product.github %}.
8686

87+
## Automation links
88+
89+
To open the Automations page in the app, encode this app link.
90+
91+
```text
92+
ghapp://automations
93+
```
94+
95+
For example:
96+
97+
```text
98+
https://github.com/copilot/app/launch?entry_point=docs_automations_link&open=ghapp%3A%2F%2Fautomations
99+
```
100+
101+
To open a new automation draft, encode an app link in this format.
102+
103+
```text
104+
ghapp://automations/new?name=Daily%20triage&trigger=daily&time=09%3A00&prompt=Summarize%20new%20issues
105+
```
106+
107+
For example:
108+
109+
```text
110+
https://github.com/copilot/app/launch?entry_point=docs_new_automation_link&open=ghapp%3A%2F%2Fautomations%2Fnew%3Fname%3DDaily%2520triage%26trigger%3Ddaily%26time%3D09%253A00%26prompt%3DSummarize%2520new%2520issues
111+
```
112+
113+
The new automation link opens a pre-filled draft for review. It does not create the automation until the user confirms in the app. Do not include secrets or sensitive information in automation prompts that are embedded in URLs.
114+
115+
To open an existing automation or automation run, encode an app link in one of these formats.
116+
117+
```text
118+
ghapp://automations/AUTOMATION_ID
119+
ghapp://automations/AUTOMATION_ID/RUN_ID
120+
```
121+
122+
For example:
123+
124+
```text
125+
https://github.com/copilot/app/launch?entry_point=docs_automation_link&open=ghapp%3A%2F%2Fautomations%2FAUTOMATION_ID
126+
https://github.com/copilot/app/launch?entry_point=docs_automation_run_link&open=ghapp%3A%2F%2Fautomations%2FAUTOMATION_ID%2FRUN_ID
127+
```
128+
129+
Automation links open local automations by default. To open a cloud automation, add `mode=cloud` to the app link before encoding it.
130+
131+
```text
132+
ghapp://automations/AUTOMATION_ID?mode=cloud
133+
ghapp://automations/AUTOMATION_ID/RUN_ID?mode=cloud
134+
```
135+
136+
For example:
137+
138+
```text
139+
https://github.com/copilot/app/launch?entry_point=docs_cloud_automation_link&open=ghapp%3A%2F%2Fautomations%2FAUTOMATION_ID%3Fmode%3Dcloud
140+
https://github.com/copilot/app/launch?entry_point=docs_cloud_automation_run_link&open=ghapp%3A%2F%2Fautomations%2FAUTOMATION_ID%2FRUN_ID%3Fmode%3Dcloud
141+
```
142+
87143
## Attribution and privacy
88144

89-
Use `entry_point` to attribute the link source without duplicating details from the `open` target. Keep the value generic and stable, and do not include repository names, issue or pull request numbers, branch names, task IDs, prompts, or raw app links in analytics events.
145+
Use `entry_point` to attribute the link source without duplicating details from the `open` target. Keep the value generic and stable, and do not include repository names, issue or pull request numbers, branch names, task IDs, automation IDs, run IDs, prompts, or raw app links in analytics events.

0 commit comments

Comments
 (0)