docs(webhook): Inventory webhook description. #2470
Merged
+139
−9
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
merlin-northern
requested review from
estenberg,
alfrunes,
tranchitella,
kjaskiewiczz and
nickanderson
|
@estenberg this is more fyi Eystein, we will have to adjust the existing screenshots later. |
merlin-northern
force-pushed
the
men_7450__docs_update_docs_with_webhook_types_and_describe_both_old_and_new_types_
branch
2 times, most recently
from
d5db8d3
to
1717b89
Compare
MuchoLucho
approved these changes
Oct 4, 2024
merlin-northern
force-pushed
the
men_7450__docs_update_docs_with_webhook_types_and_describe_both_old_and_new_types_
branch
2 times, most recently
from
5bf2d6c
to
a1f7ddf
Compare
tranchitella
approved these changes
Oct 4, 2024
nickanderson
approved these changes
Oct 4, 2024
Comment on lines
8
to
10
| to notify external applications about device lifecycle and inventory changed events. This helps | ||
| you avoid polling and manual synchronization between Mender and other systems, as well as allows | ||
| you to handle device-related events and integrate Mender into your ecosystem seamlessly. |
There was a problem hiding this comment.
Suggested change
| to notify external applications about device lifecycle and inventory changed events. This helps | |
| you avoid polling and manual synchronization between Mender and other systems, as well as allows | |
| you to handle device-related events and integrate Mender into your ecosystem seamlessly. | |
| to notify external applications about device lifecycle and inventory changed events. This eliminates the need for manual polling and synchronization, allowing for efficient handling of device-related events. |
There was a problem hiding this comment.
fixed. I only could not resist and added extra sentence about integration.
|
|
||
| This integration is available in all Mender plans, as well as Mender Open Source. | ||
| We divided webhook integrations into two categories (_scopes_): `deviceauth` and `inventory`. | ||
| The former is available in all Mender plans, as well as Mender Open Source, |
There was a problem hiding this comment.
I want to suggest a link to mender plans here when mentioned. I dunno how stable that url is. https://mender.io/pricing/plans
Comment on lines
24
to
27
| You need an external service or application exposed on the internet and able to receive data | ||
| from Mender in the form of an HTTP POST request. The hostname part of the URL must resolve | ||
| to a globally routable unicast IP address. We recommend using HTTPS and configuring | ||
| a secret for request signing purposes (see [below](#signature-header)). |
There was a problem hiding this comment.
Suggested change
| You need an external service or application exposed on the internet and able to receive data | |
| from Mender in the form of an HTTP POST request. The hostname part of the URL must resolve | |
| to a globally routable unicast IP address. We recommend using HTTPS and configuring | |
| a secret for request signing purposes (see [below](#signature-header)). | |
| To receive data from Mender, you'll need an internet-accessible service or app that can accept HTTP POST requests. The service's domain name should resolve to a publicly accessible IP address. For security, we recommend using HTTPS and setting up a secret for verifying request authenticity (see [below](#signature-header)). |
There was a problem hiding this comment.
fixed. I just added unicast. I like that word. Unicast.
| * device provisioning, | ||
| * device decommissioning, or | ||
| * its authentication status changes. | ||
|
|
||
| ### Inventory changed triggers | ||
|
|
||
| A webhook in the `inventory` scope fires when device changed inventory events: |
There was a problem hiding this comment.
Suggested change
| A webhook in the `inventory` scope fires when device changed inventory events: | |
| A webhook in the `inventory` scope fires whenever Mender Server detects and updates a change in a device's inventory information. |
| ### Inventory changed triggers | ||
|
|
||
| A webhook in the `inventory` scope fires when device changed inventory events: | ||
| * Mender Server detected a change in the device inventory and updated it in the db |
There was a problem hiding this comment.
Suggested change
| * Mender Server detected a change in the device inventory and updated it in the db |
|
|
||
| If you specify a secret, an integrity check is calculated and located in the `X-Men-Signature` header, which contains the HMAC-SHA256 of the payload using the configured secret. | ||
| If you specify a secret, an integrity check is calculated and located in the `X-Men-Signature` header, |
There was a problem hiding this comment.
Why X-Men? Could be Avengers, Fantastic Four, Justice League, Teen Titans.
There was a problem hiding this comment.
haha! a. I like XMen second: can we make it Spiderman?
Changelog: Title Ticket: MEN-7450 Signed-off-by: Peter Grzybowski <[email protected]>
merlin-northern
force-pushed
the
men_7450__docs_update_docs_with_webhook_types_and_describe_both_old_and_new_types_
branch
from
a1f7ddf
to
34e18c2
Compare
|
Merging these commits will result in the following changelog entries: Changelogsmender-docs (men_7450__docs_update_docs_with_webhook_types_and_describe_both_old_and_new_types_)New changes in mender-docs since master:
|
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.
Changelog: Title
Ticket: MEN-7450