@@ -280,30 +280,30 @@ pwsh setup_secrets.ps1 -clear
280
280
281
281
### Integrations and IntegrationConfigurations
282
282
283
- Organizations can configure Integrations and IntegrationConfigurations to send events to different
284
- endpoints. Each handler maps to a specific integration and checks for the configuration when it
285
- receives an event. Currently, there are integrations/ handlers for Slack and webhooks (as mentioned
283
+ Organizations can configure integration configurations to send events to different
284
+ endpoints -- each handler maps to a specific integration and checks for the configuration when it
285
+ receives an event. Currently, there are integrations / handlers for Slack and webhooks (as mentioned
286
286
above).
287
287
288
- **OrganizationIntegration**
288
+ **` OrganizationIntegration` **
289
289
290
- - This is the top level object that enables a specific integration for the Organization
291
- - It includes any properties that apply to the entire integration across all events
290
+ - The top level object that enables a specific integration for the organization.
291
+ - Includes any properties that apply to the entire integration across all events.
292
292
293
- - For slack , it consists of the token:
293
+ - For Slack , it consists of the token:
294
294
295
295
```json
296
296
{ "token": "xoxb-token-from-slack" }
297
297
```
298
298
299
299
- For webhooks, it is `null`. However, even though there is no configuration, an organization must
300
300
have a webhook `OrganizationIntegration` to enable configuration via
301
- `OrganizationIntegrationConfiguration`
301
+ `OrganizationIntegrationConfiguration`.
302
302
303
- **OrganizationIntegrationConfiguration**
303
+ **` OrganizationIntegrationConfiguration` **
304
304
305
305
- This contains the configurations specific to each `EventType` for the integration.
306
- - `Configuration` contains the event-specific configuration
306
+ - `Configuration` contains the event-specific configuration.
307
307
308
308
- For Slack, this would contain what channel to send the message to:
309
309
@@ -317,14 +317,14 @@ above).
317
317
{ "url": "https://api.example.com" }
318
318
```
319
319
320
- - `Template` contains a template string the is expected to be filled in with the contents of the
320
+ - `Template` contains a template string that is expected to be filled in with the contents of the
321
321
actual event.
322
322
- The tokens in the string are wrapped in `#` characters. For instance, the UserId would be
323
323
`#UserId#`
324
324
- The `IntegrationTemplateProcessor` does the actual work of replacing these tokens with
325
325
introspected values from the provided `EventMessage`.
326
- - Note that the template does not enforce any structure - it could be a freeform text message to
327
- send via Slack, or a JSON body to send via webhook. We simply store and use it as a string for
326
+ - The template does not enforce any structure - - it could be a freeform text message to
327
+ send via Slack, or a JSON body to send via webhook; it is simply stored and used as a string for
328
328
the most flexibility.
329
329
330
330
**OrganizationIntegrationConfigurationDetails**
0 commit comments