Open
Conversation
Collaborator
Author
|
cc @xlt208 - I can't tag you as a reviewer, please I welcome feedback. |
|
@khibma - I will take a look at this today. Thank you! |
xlt208
approved these changes
Mar 31, 2026
xlt208
left a comment
xlt208
left a comment
There was a problem hiding this comment.
Everything looks great. I have two minor suggestions on the write-up below, and a few small, picky comments on the notebook:
- For readability, it might be worth formatting
samplePayloadwith each property on its own line. - It would be great to place all imports in a single cell. You can use the "Organize Imports" tool in VS Code to ensure they are correctly ordered.
- I also noticed some trailing whitespace and minor formatting issues in the notebook, which should be easy to resolve using "Notebook: Format Notebook" in VS Code.
Thank you!
|
|
||
| ## Organization and Service webhooks to Notebook Server | ||
|
|
||
| Both organization and service webhooks can be directed to ArcGIS Notebook Server. The incoming webhook message will ultimately trigger a Python notebook, in turn, running Python code. This pattern enjoys the benefits of leveraging the Notebook Server infrastructure with the flexibility of developer workflows, supported by the ArcGIS for Python API. |
There was a problem hiding this comment.
Suggested change
| Both organization and service webhooks can be directed to ArcGIS Notebook Server. The incoming webhook message will ultimately trigger a Python notebook, in turn, running Python code. This pattern enjoys the benefits of leveraging the Notebook Server infrastructure with the flexibility of developer workflows, supported by the ArcGIS for Python API. | |
| Both organization and service webhooks can be directed to ArcGIS Notebook Server. The incoming webhook message will ultimately trigger a Python notebook, in turn, running Python code. This pattern enjoys the benefits of leveraging the Notebook Server infrastructure with the flexibility of developer workflows, supported by the ArcGIS API for Python. |
|
|
||
| The Python code will be triggered when the webhook payload is received by the webhook receiver. In most instances, the incoming payload will be a necessary part of the workflow; the code will act upon the information inside the payload. This payload is automatically injected into the Python notebook as a variable, `webhookPayload`. | ||
|
|
||
| [!NOTE] 11.5 - 12.0 requires loading the payload as JSON: `json.loads(webhookPayload)`. 12.1 and onwards the `webhookPayload` is injected into the Notebook as a JSON object. |
There was a problem hiding this comment.
Suggested change
| [!NOTE] 11.5 - 12.0 requires loading the payload as JSON: `json.loads(webhookPayload)`. 12.1 and onwards the `webhookPayload` is injected into the Notebook as a JSON object. | |
| > [!NOTE] | |
| > 11.5 - 12.0 requires loading the payload as JSON: `json.loads(webhookPayload)`. 12.1 and onwards the `webhookPayload` is injected into the Notebook as a JSON object. |
| "outputs": [], | ||
| "source": [ | ||
| "# When developing your notebook, use an example payload, one that would be similiar to a message that triggers the notebook\n", | ||
| "samplePayload = {\"serviceType\":\"FeatureServer\",\"changesUrl\":\"https://example.com/server/rest/services/Hosted/MyService/FeatureServer/extractChanges?serverGens=%5B1773230457695,1773244883393%5D\",\"name\":\"Posting\",\"id\":\"efab8ba4-6a0b-491e-8624-73a25e15ffb0\",\"folderName\":\"\",\"serviceName\":\"MyService\",\"events\":[{\"eventType\":\"FeaturesUpdated\",\"when\":1741189389713}]}\n", |
There was a problem hiding this comment.
Suggested change
| "samplePayload = {\"serviceType\":\"FeatureServer\",\"changesUrl\":\"https://example.com/server/rest/services/Hosted/MyService/FeatureServer/extractChanges?serverGens=%5B1773230457695,1773244883393%5D\",\"name\":\"Posting\",\"id\":\"efab8ba4-6a0b-491e-8624-73a25e15ffb0\",\"folderName\":\"\",\"serviceName\":\"MyService\",\"events\":[{\"eventType\":\"FeaturesUpdated\",\"when\":1741189389713}]}\n", | |
| "samplePayload = {\"serviceType\":\"FeatureServer\",\"changesUrl\":\"https://example.com/server/rest/services/Hosted/MyService/FeatureServer/extractChanges?serverGens=%5B1773230457695,1773244883393%5D\",\"name\":\"Posting\",\"id\":\"efab8ba4-6a0b-491e-8624-73a25e15ffb0\",\"folderName\":\"\",\"serviceName\":\"MyService\",\"events\":[{\"eventType\":\"FeaturesUpdated\",\"when\":1741189389713}]}\n", | |
| "samplePayload = {\n", | |
| " \"serviceType\": \"FeatureServer\",\n", | |
| " \"changesUrl\": \"https://example.com/server/rest/services/Hosted/MyService/FeatureServer/extractChanges?serverGens=%5B1773230457695,1773244883393%5D\",\n", | |
| " \"name\": \"Posting\",\n", | |
| " \"id\": \"efab8ba4-6a0b-491e-8624-73a25e15ffb0\",\n", | |
| " \"folderName\": \"\",\n", | |
| " \"serviceName\": \"MyService\",\n", | |
| " \"events\": [\n", | |
| " {\"eventType\": \"FeaturesUpdated\", \"when\": 1741189389713}\n", | |
| " ]\n", | |
| "}\n", |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.