idea Execute Notebooks hosted in ArcGIS Online using ArcGIS API for Python in ArcGIS API for Python Ideas

Execute Notebooks hosted in ArcGIS Online using ArcGIS API for Python

ConradSchaefer__DOIT_ — Wed, 04 May 2022 09:38:06 GMT

We have notebooks in AGOL that we would like to trigger remotely using the API for Python. It appears to be a possibility if you have your own Notebook Server but it doesn't look like the functionality exists for AGOL. See the arcgis.gis.nb.NotebookManager execute_notebook() function which says "The Execute Notebook operation allows administrators to remotely run a notebook in their ArcGIS Notebook Server site"

The times we want to run our notebooks are not on a regular schedule so the task functionality in AGOL is not appropriate. The run events are customer driven and on an unpredictable schedule, and turning the notebook over to them would not be appropriate. We would like to be able to be able to run a local python script that uses the API to trigger the Notebook to execute in AGOL.

@SusanHmel__DOIT_

Re: Execute Notebooks hosted in ArcGIS Online using ArcGIS API for Python

jcarlson — Wed, 04 May 2022 11:42:31 GMT

What is the output / end result of the notebook? Have you considered just having a Python script that you can run on demand? Notebooks are great for situations when you need to see the output or explain things with markup, but if you're not even opening the notebook, you'd probably be better off with a Python script instead.

Re: Execute Notebooks hosted in ArcGIS Online using ArcGIS API for Python

ConradSchaefer__DOIT_ — Wed, 04 May 2022 13:46:09 GMT

jcarlson, We currently have administrative notebooks that have very little value visually that are running via a task in AGOL. Noone examines the outputs as long as the runs were successful. We do have successful runs notify AGOL members and include select print output content on the task run.

Our new use case is another action process. The notebook is not an inspection of data with visualizations. It's akin to an administrative process like account management etc. We would like to be able to access it with the API and execute it.

Note: I compartmentalized this idea to remote trigger. Once remote is possible then we would want to be able to pass a parameter to the notebook.

Re: Execute Notebooks hosted in ArcGIS Online using ArcGIS API for Python

jcarlson — Wed, 04 May 2022 14:08:31 GMT

The API is accessible anywhere, though. You can install the arcgis Python module on any machine and run all the same commands. For instance, I have a number of administrative tasks that I run from a Linux machine. Many of these are custom functions that take parameters, too, so it's very simple to remotely initiate a process.

We also have certain common tasks that we share through a private GitHub repository, allowing other administrators to run these administrative tasks from literally any machine with an internet connection.

Re: Execute Notebooks hosted in ArcGIS Online using ArcGIS API for Python

ConradSchaefer__DOIT_ — Wed, 04 May 2022 14:43:43 GMT

jcarlson,

ESRI has given us Notebooks in AGOL. We pay for this functionality. These notebooks are currently able to be executed on a schedule in AGOL, just not on demand.

It's worthwhile emphasizing Notebook Server allows execution of notebooks through the API, as stated above. We are requesting the same functionality for AGOL.

We are aware of how to use the ArcGIS API for Python module in a script on a local server with internet. We have many processes in place already that leverage the API. We now want to be able to execute a Notebook in AGOL through that API.

Re: Execute Notebooks hosted in ArcGIS Online using ArcGIS API for Python

jcarlson — Wed, 04 May 2022 15:11:51 GMT

I agree that triggering a notebook is a function that would be nice to have in either place, so I still think this is a good idea.

I'm just not sure why, in this particular use case, it needs to be a notebook at all if it's not actually leveraging the particular capabilities of the notebook environment.

Re: Execute Notebooks hosted in ArcGIS Online using ArcGIS API for Python - Status changed to: Under Consideration

AndrewChapkowski — Wed, 29 Jun 2022 11:57:27 GMT

Re: Execute Notebooks hosted in ArcGIS Online using ArcGIS API for Python - Status changed to: Implemented

AndrewChapkowski — Tue, 15 Nov 2022 16:59:22 GMT

This functionality will be in the 2.1.0 release.

Re: Execute Notebooks hosted in ArcGIS Online using ArcGIS API for Python

GLCAdmin — Thu, 06 Feb 2025 14:10:20 GMT

@AndrewChapkowski This didn't actually get implemented, did it? I can't find anything in the docs about an execute notebook function that works for AGOL.

Re: Execute Notebooks hosted in ArcGIS Online using ArcGIS API for Python

RichardHowe — Thu, 03 Jul 2025 07:10:39 GMT

@GLCAdmin

I think the info is here

I haven't tested it yet, but I plan to in next couple of days

Re: Execute Notebooks hosted in ArcGIS Online using ArcGIS API for Python

RichardHowe — Thu, 03 Jul 2025 10:08:16 GMT

Seems to work perfectly 🙂

Re: Execute Notebooks hosted in ArcGIS Online using ArcGIS API for Python

TD1 — Wed, 11 Feb 2026 20:50:19 GMT

@AndrewChapkowski @GLCAdmin @RichardHowe I don't see this functionality in AGOL. Can we please get this implemented in AGOL ASAP. I agree with @ConradSchaefer__DOIT_ and I need it as well. This still requires another machine to run this and we are already paying for AGOL and notebooks.

Re: Execute Notebooks hosted in ArcGIS Online using ArcGIS API for Python

RichardHowe — Thu, 12 Feb 2026 14:44:47 GMT

@TD1 Did you look at the guidance I linked to, which gives you the python command to be able to trigger a notebook that sits in AGOL?

That's what @ConradSchaefer__DOIT_ was asking for I believe. If you simply wanted to trigger the notebook from inside AGOL you could just open it and run it. I'm struggling to see a third way

Re: Execute Notebooks hosted in ArcGIS Online using ArcGIS API for Python

TD1 — Thu, 12 Feb 2026 14:56:37 GMT

@RichardHowe Yes but that python needs to still be triggered more often than 15 minutes or on demand. Can you think of a way to do this without needing to put it on my server or my PC? Maybe something on AGOL or a webhook thru make.com?

Re: Execute Notebooks hosted in ArcGIS Online using ArcGIS API for Python

RichardHowe — Thu, 12 Feb 2026 16:10:59 GMT

Ah ok, I see. Two workarounds I guess:

1. You put a repeat in the note book of the same bit of code in a while loop executing how often you wanted it to.

2. You copy the same notebook a few times over and stagger them

I can't see ESRI giving you an out of the box way to get around a schedule that they hard-coded into the notebooks. Might be better putting an ArcGIS idea in to suggest allowing more frequent runs e.g. every minute. It's also worth pointing out that if the notebook hadn't completed before the next one is due to start it will just skip that run and jump to the next one.