2019-06-20 19:32:41 +02:00
---
title: Feature Updates To slack
---
2019-06-20 18:48:25 +02:00
2022-04-22 11:16:42 +02:00
:::caution
2022-09-07 14:26:23 +02:00
refactor: move docs into new structure / fix links for SEO (#2416)
## 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.
2022-11-22 10:05:30 +01:00
This guide is deprecated. If you're looking for ways to integrate with Slack, you should refer to [the Slack add-on guide ](../reference/addons/slack.md ) instead.
2022-09-07 14:26:23 +02:00
2022-04-22 11:16:42 +02:00
:::
2021-06-04 11:17:15 +02:00
## Create a custom Slack WebHook url: {#create-a-custom-slack-webhook-url}
2019-06-20 18:48:25 +02:00
1. Go to [https://slack.com/apps/manage/custom-integrations ](https://slack.com/apps/manage/custom-integrations )
1. Click Incoming WebHooks
1. Click “Add Configuration”
2022-09-07 14:26:23 +02:00
1. This is Slack's help page on how to do this: https://api.slack.com/messaging/webhooks
2019-06-20 18:48:25 +02:00
- Choose a channel, follow the wizard, get the custom URL.
2021-06-04 11:17:15 +02:00
## Send data to Slack using an event hook function {#send-data-to-slack-using-an-event-hook-function}
2019-06-20 18:48:25 +02:00
Using the `eventHook` option, create a function that will send the data you'd like into Slack when mutation events happen.
```javascript
const unleash = require('unleash-server');
const axios = require('axios');
function onEventHook(event, eventData) {
const { createdBy: user, data } = eventData;
let text = '';
const unleashUrl = 'http://your.unleash.host.com';
2021-06-04 11:17:15 +02:00
const feature = `<${unleashUrl}/#/features/strategies/${data.name}|${data.name}>` ;
2019-06-20 18:48:25 +02:00
switch (event) {
case 'feature-created':
case 'feature-updated': {
const verb =
event === 'feature-created' ? 'created a new' : 'updated the';
text = `${user} ${verb} feature ${feature}\ndescription: ${
data.description
}\nenabled: ${data.enabled}\nstrategies: \`${JSON.stringify(
data.strategies,
)}\``;
break;
}
case 'feature-archived':
case 'feature-revived': {
const verb = event === 'feature-archived' ? 'archived' : 'revived';
text = `${user} ${verb} the feature ${feature}` ;
break;
}
default: {
console.error(`Unknown event ${event}`);
return;
}
}
axios
.post(
'https://hooks.slack.com/services/THIS_IS_WHERE_THE_CUSTOM_URL_GOES',
{
username: 'Unleash',
icon_emoji: ':unleash:', // if you added a custom emoji, otherwise you can remove this field.
text: text,
},
)
2022-09-07 14:26:23 +02:00
.then((res) => {
2019-06-20 18:48:25 +02:00
console.log(`Slack post statusCode: ${res.status}. Text: ${text}`);
})
2022-09-07 14:26:23 +02:00
.catch((error) => {
2019-06-20 18:48:25 +02:00
console.error(error);
});
}
const options = {
eventHook: onEventHook,
};
2022-09-07 14:26:23 +02:00
unleash.start(options).then((server) => {
2019-06-20 18:48:25 +02:00
console.log(`Unleash started on http://localhost:${server.app.get('port')}`);
});
```