nhyatt/bitwarden
1
0
Fork 0
mirror of https://github.com/bitwarden/server.git synced 2025-06-12 06:00:36 -05:00
Code

Another attempt to fix inline code formatting

Browse Source
This commit is contained in:
Brant DeBow 2025-06-05 18:38:11 -04:00
parent fee4094f06
commit 4885c42ed5
No known key found for this signature in database
GPG Key ID: 94411BB25947C72B
1 changed files with 19 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
src/Core/AdminConsole/Services/Implementations/EventIntegrations/README.md
View File

@ -201,45 +201,39 @@ Currently, there are integrations / handlers for Slack and webhooks (as mentione
### `OrganizationIntegration` ### `OrganizationIntegration`
- The top level object that enables a specific integration for the organization. - The top-level object that enables a specific integration for the organization.
- Includes any properties that apply to the entire integration across all events. - Includes any properties that apply to the entire integration across all events.
- For Slack, it consists of the token: - For Slack, it consists of the token:
``` json ```json
{ "token": "xoxb-token-from-slack" } { "token": "xoxb-token-from-slack" }
``` ```
- For webhooks, it is `null`. However, even though there is no configuration, an organization must - For webhooks, it is `null`. However, even though there is no configuration, an organization must
have a webhook `OrganizationIntegration` to enable configuration via have a webhook `OrganizationIntegration` to enable configuration via `OrganizationIntegrationConfiguration`.
`OrganizationIntegrationConfiguration`.
### `OrganizationIntegrationConfiguration` ### `OrganizationIntegrationConfiguration`
- This contains the configurations specific to each `EventType` for the integration. - This contains the configurations specific to each `EventType` for the integration.
- `Configuration` contains the event-specific configuration. - `Configuration` contains the event-specific configuration.
- For Slack, this would contain what channel to send the message to: - For Slack, this would contain what channel to send the message to:
``` json ```json
{ { "channelId": "C123456" }
"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 ```json
{ "url": "https://api.example.com" } { "url": "https://api.example.com" }
``` ```
- `Template` contains a template string that is expected to be filled in with the contents of the - `Template` contains a template string that is expected to be filled in with the contents of the actual event.
actual event. - The tokens in the string are wrapped in `#` characters. For instance, the UserId would be `#UserId#`.
- The tokens in the string are wrapped in `#` characters. For instance, the UserId would be - The `IntegrationTemplateProcessor` does the actual work of replacing these tokens with introspected values from
`#UserId#`. the provided `EventMessage`.
- The `IntegrationTemplateProcessor` does the actual work of replacing these tokens with - The template does not enforce any structure — it could be a freeform text message to send via Slack, or a
introspected values from the provided `EventMessage`. JSON body to send via webhook; it is simply stored and used as a string for the most flexibility.
- 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` ### `OrganizationIntegrationConfigurationDetails`