1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
unleash.unleash/website/docs/addons/webhook.md

56 lines
1.9 KiB
Markdown
Raw Normal View History

---
id: webhook
2021-02-05 14:19:04 +01:00
title: Webhook
---
> This feature was introduced in _Unleash v3.11.0_.
2021-02-05 14:19:04 +01:00
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,m and you should never assume events always comes in order.
## Configuration {#configuration}
2021-02-05 14:19:04 +01:00
#### Events {#events}
2021-02-05 14:19:04 +01:00
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
2021-02-05 14:19:04 +01:00
- feature-archived
- feature-revived
- feature-strategy-update
- feature-strategy-add
- feature-strategy-remove
2021-02-25 22:27:11 +01:00
- feature-stale-on
- feature-stale-off
- feature-environment-enabled
- feature-environment-disabled
2021-02-25 22:27:11 +01:00
> *) Deprecated, and will not be used after transition to environments in Unleash v4.3
2021-02-05 14:19:04 +01:00
#### Parameters {#parameters}
2021-02-05 14:19:04 +01:00
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.
2021-02-05 14:19:04 +01:00
**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](https://mustache.github.io). You will have the [Unleash event format](/api/admin/events) available in the rendering context.
2021-02-05 14:19:04 +01:00
Example:
```mustache
{
"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](/api/admin/events).