From 4885c42ed5bbb691dd16850d7a8265f5a50d4501 Mon Sep 17 00:00:00 2001 From: Brant DeBow Date: Thu, 5 Jun 2025 18:38:11 -0400 Subject: [PATCH] Another attempt to fix inline code formatting --- .../EventIntegrations/README.md | 44 ++++++++----------- 1 file changed, 19 insertions(+), 25 deletions(-) diff --git a/src/Core/AdminConsole/Services/Implementations/EventIntegrations/README.md b/src/Core/AdminConsole/Services/Implementations/EventIntegrations/README.md index a00ddee050..6cd7b6ba8f 100644 --- a/src/Core/AdminConsole/Services/Implementations/EventIntegrations/README.md +++ b/src/Core/AdminConsole/Services/Implementations/EventIntegrations/README.md @@ -201,45 +201,39 @@ Currently, there are integrations / handlers for Slack and webhooks (as mentione ### `OrganizationIntegration` - - The top level object that enables a specific integration for the organization. - - Includes any properties that apply to the entire integration across all events. +- The top-level object that enables a specific integration for the organization. +- Includes any properties that apply to the entire integration across all events. - For Slack, it consists of the token: - ``` json - { "token": "xoxb-token-from-slack" } + ```json + { "token": "xoxb-token-from-slack" } ``` + - For webhooks, it is `null`. However, even though there is no configuration, an organization must - have a webhook `OrganizationIntegration` to enable configuration via - `OrganizationIntegrationConfiguration`. + have a webhook `OrganizationIntegration` to enable configuration via `OrganizationIntegrationConfiguration`. ### `OrganizationIntegrationConfiguration` - - This contains the configurations specific to each `EventType` for the integration. - - `Configuration` contains the event-specific configuration. - +- This contains the configurations specific to each `EventType` for the integration. +- `Configuration` contains the event-specific configuration. - For Slack, this would contain what channel to send the message to: - ``` json - { - "channelId": "C123456" - } + ```json + { "channelId": "C123456" } ``` - - For Webhooks, this is the URL the request should be sent to: + - For Webhook, this is the URL the request should be sent to: - ``` json - { "url": "https://api.example.com" } + ```json + { "url": "https://api.example.com" } ``` - - `Template` contains a template string that is expected to be filled in with the contents of the - actual event. - - The tokens in the string are wrapped in `#` characters. For instance, the UserId would be - `#UserId#`. - - The `IntegrationTemplateProcessor` does the actual work of replacing these tokens with - introspected values from the provided `EventMessage`. - - The template does not enforce any structure -- it could be a freeform text message to send via - Slack, or a JSON body to send via webhook; it is simply stored and used as a string for the most - flexibility. +- `Template` contains a template string that is expected to be filled in with the contents of the actual event. + - The tokens in the string are wrapped in `#` characters. For instance, the UserId would be `#UserId#`. + - The `IntegrationTemplateProcessor` does the actual work of replacing these tokens with introspected values from + the provided `EventMessage`. + - The template does not enforce any structure — it could be a freeform text message to send via Slack, or a + JSON body to send via webhook; it is simply stored and used as a string for the most flexibility. ### `OrganizationIntegrationConfigurationDetails`