From e864be6a02cc62d688f1065c37b3111c66e9a91b Mon Sep 17 00:00:00 2001 From: oomIRL <103235538+oomIRL@users.noreply.github.com> Date: Mon, 8 Jun 2026 17:02:47 -0700 Subject: [PATCH 01/10] draft governance --- docs/webhooks/governance.md | 33 +++++++++++++++++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 34 insertions(+) create mode 100644 docs/webhooks/governance.md diff --git a/docs/webhooks/governance.md b/docs/webhooks/governance.md new file mode 100644 index 0000000..953453e --- /dev/null +++ b/docs/webhooks/governance.md @@ -0,0 +1,33 @@ +# Webhook & workflow governance + +The DevX team-developed app that provides webhook functionality in MS Teams will be called “Relay”. This is a Teams app (plugin) that is installed on a per Team basis. The ability to install the app will be restricted by security group membership. + +## Responsibilities + +**DevX** team is responsible for: + +* Developing and maintaining Relay app code +* Supporting API in OpenShift Gold DR hosted environment +* Maintaining connectivity to DevX instance of the workflow instance, provided by the Workflows team +* Onboarding clients and managing security group membership +* Maintaining support material including: + * Keeping support scripts with 77000 service desk current + * Relay-specific support and user education for workflow integration + * Related web content on DevHub (developer.gov.bc.ca) + +**Digital Workplace** team is responsible for: + +* Maintaining MS Teams as an enterprise core service +* Gatekeeping and publishing Teams apps including updates. In this case, specifically the Relay app + +**Workflows** team is responsible for: + +* Maintaining the underlying workflow service. In this case, specifically the DevX instance with high availability (Gold DR) +* Generalized support and user education for the workflow service +* Supporting DevX team as needed to maintain end-to-end webhook functionality in Teams + +**Relay users / clients** are responsible for: + +* Maintaining their product listing and keeping current contacts with the DevX team’s client listing. +* Only using the Relay functionality on agreed channels, in collaboration with DevX team +* Maintaining the workflow within n8n diff --git a/mkdocs.yml b/mkdocs.yml index b6ee8b7..a1c3159 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -57,6 +57,7 @@ nav: - Onboarding guide:Microsoft Teams Webhook Integration: webhooks/msteams-webhooks.md - Install Relay and create your first workflow: webhooks/create-workflow.md - Troubleshooting guide: webhooks/troubleshooting.md + - Webhook & workflow governance: webhooks/governance.md - Quickstart Wizards: - Quickstart for OpenShift Wizard: wizards/quickstart-for-openshift-wizard.md From 6f27a480b20be6e3b4b9ca6c8a99f1991f997c8c Mon Sep 17 00:00:00 2001 From: oomIRL <103235538+oomIRL@users.noreply.github.com> Date: Wed, 10 Jun 2026 14:20:12 -0700 Subject: [PATCH 02/10] Expanded on the notes a bit --- docs/webhooks/governance.md | 53 +++++++++++++++++++++++++++---------- 1 file changed, 39 insertions(+), 14 deletions(-) diff --git a/docs/webhooks/governance.md b/docs/webhooks/governance.md index 953453e..465a233 100644 --- a/docs/webhooks/governance.md +++ b/docs/webhooks/governance.md @@ -1,33 +1,58 @@ # Webhook & workflow governance -The DevX team-developed app that provides webhook functionality in MS Teams will be called “Relay”. This is a Teams app (plugin) that is installed on a per Team basis. The ability to install the app will be restricted by security group membership. +Relay is the DevX team-developed app that provides messaging functionality in MS Teams. +It has two principal components: +1. An API service that validates incoming data and then posts messages to MS Teams +1. A MS Teams app installed on a per-Team basis that functions as a credential for the API +The ability to install the MS Teams app is restricted by security group membership. + +This document outlines the governance model and responsibility boundaries for Relay, including app ownership, workflow platform dependencies, support expectations, and client responsibilities. ## Responsibilities -**DevX** team is responsible for: +### DevX Team +The **DevX team** is responsible for: -* Developing and maintaining Relay app code -* Supporting API in OpenShift Gold DR hosted environment -* Maintaining connectivity to DevX instance of the workflow instance, provided by the Workflows team +* Developing and maintaining Relay application code +* Supporting the Relay API hosted in the OpenShift Gold DR environment +* (dbl check this) Maintaining connectivity to the DevX instance of the workflow service, provided by the Workflows team * Onboarding clients and managing security group membership * Maintaining support material including: * Keeping support scripts with 77000 service desk current * Relay-specific support and user education for workflow integration * Related web content on DevHub (developer.gov.bc.ca) -**Digital Workplace** team is responsible for: +### Digital Workplace Team +The **Digital Workplace team** is responsible for: * Maintaining MS Teams as an enterprise core service -* Gatekeeping and publishing Teams apps including updates. In this case, specifically the Relay app +* Gatekeeping, publishing, and updating Teams apps, including the Relay app -**Workflows** team is responsible for: +### Workflows Team +The **Workflows** team is responsible for: -* Maintaining the underlying workflow service. In this case, specifically the DevX instance with high availability (Gold DR) -* Generalized support and user education for the workflow service +* Maintaining the underlying workflow service used by Relay +* Providing and supprting the DevX instance of the workflow service with high availability +* Providing general support and user education for the workflow service * Supporting DevX team as needed to maintain end-to-end webhook functionality in Teams -**Relay users / clients** are responsible for: +### Relay Users / Clients +**Relay users and clients** are responsible for: + +* Maintaining their product listing and keeping current contacts with the DevX team’s client listing +* Using Relay only for agreed-upon Teams and channels, in collaboration with DevX team +* Maintaining their own workflows in the workflow service +* Ensuring webhook payloads and workflow logic are appropriate for the intended Teams channel + +## Support Model + +Relay support follows a shared responsibility model. + +The DevX team provides support for Relay onboarding, API service, Teams webhook integration, and Relay troubleshooting. + +The Workflows team provides support for the underlying workflow platform, including workflow service availability, platform issues, and general workflow guidance. + +Relay users are responsible for maintaing their own workflow logic, validating payloads from source systems, and ensuring messages are posted only to approved Teams channels. + +Issues that cannot be neatly attributed to a single area should be triaged collaboratively by DevX and Workflows. -* Maintaining their product listing and keeping current contacts with the DevX team’s client listing. -* Only using the Relay functionality on agreed channels, in collaboration with DevX team -* Maintaining the workflow within n8n From 87a5e304606df3bbae324ca6c0a3fbeb78a68f11 Mon Sep 17 00:00:00 2001 From: oomIRL <103235538+oomIRL@users.noreply.github.com> Date: Wed, 10 Jun 2026 14:58:45 -0700 Subject: [PATCH 03/10] Formatting corrections --- docs/webhooks/governance.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/webhooks/governance.md b/docs/webhooks/governance.md index 465a233..582f4d2 100644 --- a/docs/webhooks/governance.md +++ b/docs/webhooks/governance.md @@ -1,9 +1,11 @@ # Webhook & workflow governance Relay is the DevX team-developed app that provides messaging functionality in MS Teams. -It has two principal components: +It has two principal components: + 1. An API service that validates incoming data and then posts messages to MS Teams -1. A MS Teams app installed on a per-Team basis that functions as a credential for the API +1. A MS Teams app installed on a per-Team basis that functions as a credential for the API + The ability to install the MS Teams app is restricted by security group membership. This document outlines the governance model and responsibility boundaries for Relay, including app ownership, workflow platform dependencies, support expectations, and client responsibilities. @@ -18,9 +20,9 @@ The **DevX team** is responsible for: * (dbl check this) Maintaining connectivity to the DevX instance of the workflow service, provided by the Workflows team * Onboarding clients and managing security group membership * Maintaining support material including: - * Keeping support scripts with 77000 service desk current - * Relay-specific support and user education for workflow integration - * Related web content on DevHub (developer.gov.bc.ca) + * Keeping support scripts with 77000 service desk current + * Relay-specific support and user education for workflow integration + * Related web content on DevHub (developer.gov.bc.ca) ### Digital Workplace Team The **Digital Workplace team** is responsible for: From 38904b9b1ae39ad59cad573f2f75b3ec44f06e1f Mon Sep 17 00:00:00 2001 From: oomIRL <103235538+oomIRL@users.noreply.github.com> Date: Wed, 10 Jun 2026 15:08:14 -0700 Subject: [PATCH 04/10] spacing change --- docs/webhooks/governance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/webhooks/governance.md b/docs/webhooks/governance.md index 582f4d2..e1f57d9 100644 --- a/docs/webhooks/governance.md +++ b/docs/webhooks/governance.md @@ -11,7 +11,7 @@ The ability to install the MS Teams app is restricted by security group membersh This document outlines the governance model and responsibility boundaries for Relay, including app ownership, workflow platform dependencies, support expectations, and client responsibilities. ## Responsibilities - + ### DevX Team The **DevX team** is responsible for: From 87873a80745cd054901c9e7c423acfd6350e7e48 Mon Sep 17 00:00:00 2001 From: oomIRL <103235538+oomIRL@users.noreply.github.com> Date: Wed, 10 Jun 2026 15:18:24 -0700 Subject: [PATCH 05/10] more minor adjustments --- docs/webhooks/governance.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/webhooks/governance.md b/docs/webhooks/governance.md index e1f57d9..970bb24 100644 --- a/docs/webhooks/governance.md +++ b/docs/webhooks/governance.md @@ -1,7 +1,7 @@ # Webhook & workflow governance -Relay is the DevX team-developed app that provides messaging functionality in MS Teams. -It has two principal components: +Relay is the DevX developed app that provides messaging functionality in MS Teams. +It has two principal components: 1. An API service that validates incoming data and then posts messages to MS Teams 1. A MS Teams app installed on a per-Team basis that functions as a credential for the API @@ -11,7 +11,6 @@ The ability to install the MS Teams app is restricted by security group membersh This document outlines the governance model and responsibility boundaries for Relay, including app ownership, workflow platform dependencies, support expectations, and client responsibilities. ## Responsibilities - ### DevX Team The **DevX team** is responsible for: From 321f0cef195b2542237b9ed12a14c8514abdb52c Mon Sep 17 00:00:00 2001 From: oomIRL <103235538+oomIRL@users.noreply.github.com> Date: Wed, 10 Jun 2026 15:30:35 -0700 Subject: [PATCH 06/10] formatting --- docs/webhooks/governance.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/webhooks/governance.md b/docs/webhooks/governance.md index 970bb24..a8de75a 100644 --- a/docs/webhooks/governance.md +++ b/docs/webhooks/governance.md @@ -1,6 +1,7 @@ # Webhook & workflow governance Relay is the DevX developed app that provides messaging functionality in MS Teams. + It has two principal components: 1. An API service that validates incoming data and then posts messages to MS Teams From c5bb19a29d20e9009d4825f4a914e028fb50eb21 Mon Sep 17 00:00:00 2001 From: oomIRL <103235538+oomIRL@users.noreply.github.com> Date: Wed, 10 Jun 2026 15:35:47 -0700 Subject: [PATCH 07/10] typo --- docs/webhooks/governance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/webhooks/governance.md b/docs/webhooks/governance.md index a8de75a..44445e9 100644 --- a/docs/webhooks/governance.md +++ b/docs/webhooks/governance.md @@ -34,7 +34,7 @@ The **Digital Workplace team** is responsible for: The **Workflows** team is responsible for: * Maintaining the underlying workflow service used by Relay -* Providing and supprting the DevX instance of the workflow service with high availability +* Providing and supporting the DevX instance of the workflow service with high availability * Providing general support and user education for the workflow service * Supporting DevX team as needed to maintain end-to-end webhook functionality in Teams From 270d7f59cc03ab3a8f8ea4b7fff4e7c9b775ea57 Mon Sep 17 00:00:00 2001 From: Pilar Solares Date: Thu, 11 Jun 2026 13:05:23 -0700 Subject: [PATCH 08/10] Minor changes Changes headings upper case, oxford comma, related information supporting docs, updated for mdocs and minor changes to teams guide to include community-of-practice channels too. --- .../developer-community-ms-teams-guide.md | 3 +- docs/webhooks/governance.md | 30 +++++++++++-------- docs/webhooks/troubleshooting.md | 2 +- mkdocs.yml | 4 +-- 4 files changed, 23 insertions(+), 16 deletions(-) diff --git a/docs/developer-community/developer-community-ms-teams-guide.md b/docs/developer-community/developer-community-ms-teams-guide.md index 3319935..8e9c289 100644 --- a/docs/developer-community/developer-community-ms-teams-guide.md +++ b/docs/developer-community/developer-community-ms-teams-guide.md @@ -139,7 +139,8 @@ Common purposes include: * **alerts** - Notices, maintenance updates and planned outages * **emergencyhelp** - Urgent issues only * **training** - Training related support -* **communitychat** - Usually only used for non-service channels like General-communitychat-kudos +* **communitychat** - Usually only used for non-service channels like [General-communitychat-kudos](https://teams.microsoft.com/l/channel/19%3A0e99940131d3460ca765b0004c51cef4%40thread.tacv2/General-communitychat-kudos?groupId=a80418da-c27b-406e-89ab-7695b61924d8&tenantId=6fdb5200-3d0d-4a8a-b036-d3685e359adc) +* **community-of-practice** - Usually only used for non service channels like common technology tools like [Drupal-community-of-practice](https://teams.microsoft.com/l/channel/19%3A60b2606b9151428282e79f0899d1d50e%40thread.tacv2/Drupal-community-of-practice?groupId=a80418da-c27b-406e-89ab-7695b61924d8&tenantId=6fdb5200-3d0d-4a8a-b036-d3685e359adc) For self-paced training, use hyphenated purposes such as training-selfpaced. diff --git a/docs/webhooks/governance.md b/docs/webhooks/governance.md index 44445e9..929cd5a 100644 --- a/docs/webhooks/governance.md +++ b/docs/webhooks/governance.md @@ -1,15 +1,15 @@ -# Webhook & workflow governance +# Webhook and workflow governance -Relay is the DevX developed app that provides messaging functionality in MS Teams. +Relay is the Developer Experience (DevX) developed app that provides messaging functionality in Microsoft Teams. It has two principal components: 1. An API service that validates incoming data and then posts messages to MS Teams -1. A MS Teams app installed on a per-Team basis that functions as a credential for the API +2. A MS Teams app installed on a per-Team basis that functions as a credential for the API The ability to install the MS Teams app is restricted by security group membership. -This document outlines the governance model and responsibility boundaries for Relay, including app ownership, workflow platform dependencies, support expectations, and client responsibilities. +This document outlines the governance model and responsibility boundaries for Relay, including app ownership, workflow platform dependencies, support expectations and client responsibilities. ## Responsibilities ### DevX Team @@ -24,13 +24,13 @@ The **DevX team** is responsible for: * Relay-specific support and user education for workflow integration * Related web content on DevHub (developer.gov.bc.ca) -### Digital Workplace Team +### Digital Workplace team The **Digital Workplace team** is responsible for: * Maintaining MS Teams as an enterprise core service -* Gatekeeping, publishing, and updating Teams apps, including the Relay app +* Gatekeeping, publishing and updating Teams apps, including the Relay app -### Workflows Team +### Workflows team The **Workflows** team is responsible for: * Maintaining the underlying workflow service used by Relay @@ -38,7 +38,7 @@ The **Workflows** team is responsible for: * Providing general support and user education for the workflow service * Supporting DevX team as needed to maintain end-to-end webhook functionality in Teams -### Relay Users / Clients +### Relay users and clients **Relay users and clients** are responsible for: * Maintaining their product listing and keeping current contacts with the DevX team’s client listing @@ -46,15 +46,21 @@ The **Workflows** team is responsible for: * Maintaining their own workflows in the workflow service * Ensuring webhook payloads and workflow logic are appropriate for the intended Teams channel -## Support Model +## Support model Relay support follows a shared responsibility model. -The DevX team provides support for Relay onboarding, API service, Teams webhook integration, and Relay troubleshooting. +The DevX team provides support for Relay onboarding, API service, Teams webhook integration and Relay troubleshooting. -The Workflows team provides support for the underlying workflow platform, including workflow service availability, platform issues, and general workflow guidance. +The Workflows team provides support for the underlying workflow platform, including workflow service availability, platform issues and general workflow guidance. -Relay users are responsible for maintaing their own workflow logic, validating payloads from source systems, and ensuring messages are posted only to approved Teams channels. +Relay users are responsible for maintaining their own workflow logic, validating payloads from source systems and ensuring messages are posted only to approved Teams channels. Issues that cannot be neatly attributed to a single area should be triaged collaboratively by DevX and Workflows. +## Related information + +* [Onboarding guide: Microsoft Teams webhook integration](../webhooks/msteams-webhooks.md) +* [Install Relay and create your first workflow](../webhooks/create-workflow.md) +* [Troubleshooting webhook guide](../webhooks/troubleshooting.md) + diff --git a/docs/webhooks/troubleshooting.md b/docs/webhooks/troubleshooting.md index dd9ae73..646e9c5 100644 --- a/docs/webhooks/troubleshooting.md +++ b/docs/webhooks/troubleshooting.md @@ -1,4 +1,4 @@ -# Troubleshooting +# Troubleshooting webhook guide This guide addresses common issues encountered when integrating the Relay app and n8n workflows. It covers workflow execution failures, message delivery problems, and payload format mismatches. Use this reference to diagnose and resolve issues. diff --git a/mkdocs.yml b/mkdocs.yml index a1c3159..f6dbd78 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -56,8 +56,8 @@ nav: - Relay app and webhook integration: - Onboarding guide:Microsoft Teams Webhook Integration: webhooks/msteams-webhooks.md - Install Relay and create your first workflow: webhooks/create-workflow.md - - Troubleshooting guide: webhooks/troubleshooting.md - - Webhook & workflow governance: webhooks/governance.md + - Troubleshooting webhook guide: webhooks/troubleshooting.md + - Webhook and workflow governance: webhooks/governance.md - Quickstart Wizards: - Quickstart for OpenShift Wizard: wizards/quickstart-for-openshift-wizard.md From 7b18d19e567d21a76b8a927925d6df7fbed2810e Mon Sep 17 00:00:00 2001 From: Pilar Solares Date: Thu, 11 Jun 2026 13:14:18 -0700 Subject: [PATCH 09/10] Update governance.md --- docs/webhooks/governance.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/webhooks/governance.md b/docs/webhooks/governance.md index 929cd5a..828b914 100644 --- a/docs/webhooks/governance.md +++ b/docs/webhooks/governance.md @@ -1,6 +1,6 @@ # Webhook and workflow governance -Relay is the Developer Experience (DevX) developed app that provides messaging functionality in Microsoft Teams. +Relay is the Developer Experience team (DevX) developed app that provides messaging functionality in Microsoft Teams. It has two principal components: @@ -12,7 +12,7 @@ The ability to install the MS Teams app is restricted by security group membersh This document outlines the governance model and responsibility boundaries for Relay, including app ownership, workflow platform dependencies, support expectations and client responsibilities. ## Responsibilities -### DevX Team +### DevX team The **DevX team** is responsible for: * Developing and maintaining Relay application code From 17ed87b4094860a6eea57d63970b9abf1f3c9576 Mon Sep 17 00:00:00 2001 From: oomIRL <103235538+oomIRL@users.noreply.github.com> Date: Fri, 12 Jun 2026 10:25:35 -0700 Subject: [PATCH 10/10] Update DW team name --- docs/webhooks/governance.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/webhooks/governance.md b/docs/webhooks/governance.md index 828b914..e223b4e 100644 --- a/docs/webhooks/governance.md +++ b/docs/webhooks/governance.md @@ -24,8 +24,8 @@ The **DevX team** is responsible for: * Relay-specific support and user education for workflow integration * Related web content on DevHub (developer.gov.bc.ca) -### Digital Workplace team -The **Digital Workplace team** is responsible for: +### Teams Service Delivery team +The **Teams Service Delivery team** is responsible for: * Maintaining MS Teams as an enterprise core service * Gatekeeping, publishing and updating Teams apps, including the Relay app