feat(xo-server-web-hooks): handle office 365 connector format #8498
Conversation
This file contains 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
|
Probably worth a highlight for the next release 👍 |
b-Nollet
requested changes
Apr 10, 2025
| @@ -141,6 +173,11 @@ export const configurationSchema = ({ xo: { apiMethods } }) => ({ | |||
| title: 'URL', | |||
| type: 'string', | |||
| }, | |||
| isOfficeHook: { | |||
| description: 'Enable if your URL require a payload that follow the office 365 connector format', | |||
There was a problem hiding this comment.
Suggested change
| description: 'Enable if your URL require a payload that follow the office 365 connector format', | |
| description: 'Enable if your URL requires a payload that follow the office 365 connector format', |
| @@ -163,6 +200,11 @@ export const testSchema = { | |||
| type: 'string', | |||
| description: 'The URL the test request will be sent to', | |||
| }, | |||
| isOfficeHook: { | |||
| description: 'Enable if your URL require a payload that follow the office 365 connector format', | |||
There was a problem hiding this comment.
Suggested change
| description: 'Enable if your URL require a payload that follow the office 365 connector format', | |
| description: 'Enable if your URL requires a payload that follow the office 365 connector format', |
pdonias
reviewed
Apr 10, 2025
Comment on lines
+5
to
+23
| function constructPayload(isOfficeHook, data, type) { | ||
| if (isOfficeHook) { | ||
| // https://learn.microsoft.com/en-us/outlook/actionable-messages/message-card-reference | ||
| const facts = Object.keys(data).map(key => { | ||
| const value = data[key] | ||
| return { name: key, value: typeof value === 'string' ? value : JSON.stringify(value) } | ||
| }) | ||
|
|
||
| return { | ||
| '@type': 'MessageCard', | ||
| '@context': 'https://schema.org/extensions', | ||
| themeColor: 'BE1621', | ||
| summary: 'New notification from the Xen-Orchestra webhook plugin', | ||
| sections: [{ title: `XO ${type.toUpperCase()} notification` }, { facts }], | ||
| } | ||
| } | ||
|
|
||
| return { ...data, type } | ||
| } |
There was a problem hiding this comment.
Since we want to support multiple formats, we might want to:
- Use an enum in the configuration
- Return a string here instead of an object (to be able to support non-JSON formats in the future)
What do you think?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Microsoft teams webhook require a payload in the office 365 connector format.
This PR add a toggle in the plugin configuration to handle URL that require payload in this format.
zammad#36742
Screenshots
Checklist
Fixes #007,See xoa-support#42,See https://...)Introduced byCHANGELOG.unreleased.mdReview process
Notes: