d5fbd0b743
## What This (admittedly massive) PR updates the "physical" documentation structure and fixes url inconsistencies and SEO problems reported by marketing. The main points are: - remove or move directories : advanced, user_guide, deploy, api - move the files contained within to the appropriate one of topics, how-to, tutorials, or reference - update internal doc links and product links to the content - create client-side redirects for all the urls that have changed. A number of the files have been renamed in small ways to better match their url and to make them easier to find. Additionally, the top-level api directory has been moved to /reference/api/legacy/unleash (see the discussion points section for more on this). ## Why When moving our doc structure to diataxis a while back, we left the "physical' files lying where they were, because it didn't matter much to the new structure. However, that did introduce some inconsistencies with where you place docs and how we organize them. There's also the discrepancies in whether urls us underscores or hyphens (which isn't necessarily the same as their file name), which has been annoying me for a while, but now has also been raised by marketing as an issue in terms of SEO. ## Discussion points The old, hand-written API docs have been moved from /api to /reference/api/legacy/unleash. There _is_ a /reference/api/unleash directory, but this is being populated by the OpenAPI plugin, and mixing those could only cause trouble. However, I'm unsure about putting /legacy/ in the title, because the API isn't legacy, the docs are. Maybe we could use another path? Like /old-docs/ or something? I'd appreciate some input on this.
2.4 KiB
| id | title |
|---|---|
| webhook | Webhook |
This feature was introduced in Unleash v3.11.0.
The Webhook Addon introduces a generic way to post messages from Unleash to third party services. Unleash allows you to define a webhook which listens changes in Unleash and post them to a third party services.
The webhook will perform a single retry if the HTTP POST call fails (either a 50x or network error). Duplicate events may happen, and you should never assume events always comes in order.
Configuration
Events
You can choose to trigger updates for the following events (we might add more event types in the future):
- feature-created
- feature-updated (*)
- feature-metadata-updated
- feature-project-change
- feature-archived
- feature-revived
- feature-strategy-update
- feature-strategy-add
- feature-strategy-remove
- feature-stale-on
- feature-stale-off
- feature-environment-enabled
- feature-environment-disabled
*) Deprecated, and will not be used after transition to environments in Unleash v4.3
Parameters
Unleash Webhook addon takes the following parameters.
Webhook URL This is the only required property. If you are using a Slack Application you must also make sure your application is allowed to post the channel you want to post to.
Content-Type Used to set the content-type header used when unleash performs an HTTP POST to the defined endpoint.
Body template Used to override the body template used by Unleash when performing the HTTP POST. You may format you message using a Mustache template. You will have the Unleash event format available in the rendering context.
Example:
{
"event": "{{event.type}}",
"createdBy": "{{event.createdBy}}",
"featureToggle": "{{event.data.name}}",
"timestamp": "{{event.data.createdAt}}"
}
If you don't specify anything Unleash will use the Unleash event format.
Custom SSL certificates
If your webhook endpoint uses a custom SSL certificate,
you will need to start Unleash with the NODE_EXTRA_CA_CERTS environment variable set.
It needs to point to your custom certificate file in pem format.
For more information, see the official Node.js documentation on setting extra certificate files.