Notifications, intégration Slack et webhooks

Avez-vous déjà souhaité informer vos coéquipiers ou votre client que vous avez déployé une nouvelle version de votre application sur Scalingo ? C'est désormais possible grâce à notre nouveau système de notifications, aux webhooks sortants et à l'intégration Slack.

Notifications

Chez Scalingo, nous transmettons régulièrement des informations importantes aux utilisateurs concernant les évolutions et événements liés à la plateforme, à leurs applications ou à leur compte.
Avec ce nouveau système de notifications, vous pouvez désormais partager ces informations en dehors de notre plateforme.

C’est particulièrement utile pour tenir votre équipe informée des déploiements, mais aussi pour connecter différents systèmes entre eux.

Pour cette première version, un seul type de notification est disponible : les notifications de déploiement.
Elles vous permettent d’être informé à chaque fois qu’une nouvelle version de votre application est déployée.

Intégration Slack

L'intégration Slack est assez simple à mettre en place, à condition de savoir où chercher dans la configuration 🙂

Rendez-vous dans votre espace Slack, puis dans la section « Apps & integrations ».
Recherchez l’application « Incoming WebHooks », puis récupérez l’URL du webhook.

Copiez ensuite cette URL dans le champ prévu à cet effet, dans le sous-menu « Notifications » de votre application sur le dashboard Scalingo.

Webhooks

Les webhooks offrent un moyen plus générique de communiquer avec des services externes à la plateforme Scalingo.

Une fois une URL renseignée dans le champ « Notifications » de votre application, nous enverrons une requête HTTP POST contenant les données (payload) décrites ci-dessous.

Voici un exemple de payload JSON envoyé :

{
"id": "54dcdd4a73636100011a0000",
"created_at" : "2015-02-12T18:05:14.226+01:00",
"user" : {
"username" : "johndoe",
"email" : "john@doe.com",
"id" : "51e6bc626edfe40bbb000001"
},
"app_id" : "5343eccd646173000a140000",
"app_name": "appname",
"type": "deployment",
"type_data": {
"deployment_id" : "5343eccd646aa3012a140230",
"pusher": "johndoe",
"git_ref" : "0123456789abcdef",
"status": "success",
"duration": 40
}
}

{
"id": "54dcdd4a73636100011a0000",
"created_at" : "2015-02-12T18:05:14.226+01:00",
"user" : {
"username" : "johndoe",
"email" : "john@doe.com",
"id" : "51e6bc626edfe40bbb000001"
},
"app_id" : "5343eccd646173000a140000",
"app_name": "appname",
"type": "deployment",
"type_data": {
"deployment_id" : "5343eccd646aa3012a140230",
"pusher": "johndoe",
"git_ref" : "0123456789abcdef",
"status": "success",
"duration": 40
}
}

{
"id": "54dcdd4a73636100011a0000",
"created_at" : "2015-02-12T18:05:14.226+01:00",
"user" : {
"username" : "johndoe",
"email" : "john@doe.com",
"id" : "51e6bc626edfe40bbb000001"
},
"app_id" : "5343eccd646173000a140000",
"app_name": "appname",
"type": "deployment",
"type_data": {
"deployment_id" : "5343eccd646aa3012a140230",
"pusher": "johndoe",
"git_ref" : "0123456789abcdef",
"status": "success",
"duration": 40
}
}

{
"id": "54dcdd4a73636100011a0000",
"created_at" : "2015-02-12T18:05:14.226+01:00",
"user" : {
"username" : "johndoe",
"email" : "john@doe.com",
"id" : "51e6bc626edfe40bbb000001"
},
"app_id" : "5343eccd646173000a140000",
"app_name": "appname",
"type": "deployment",
"type_data": {
"deployment_id" : "5343eccd646aa3012a140230",
"pusher": "johndoe",
"git_ref" : "0123456789abcdef",
"status": "success",
"duration": 40
}
}

Exemple de webhook avec Zapier

Zapier est l’une des plateformes d’automatisation les plus populaires sur le web. Elle fonctionne de manière similaire à IFTTT, que vous connaissez peut-être déjà.
Ces outils permettent de connecter différents services et API afin d’exécuter des scénarios automatisés.

Dans cet exemple, nous allons voir comment envoyer des emails de notification via un webhook (Scalingo ne propose pas encore l’envoi d’emails de notification nativement).

Rendez-vous sur le site de Zapier et cliquez sur « Make a Zap ».

Déclencheur (Trigger)

Pour configurer le déclencheur, recherchez l’application « Webhook by Zapier » puis choisissez « Catch Hook ».
Laissez le champ « Pick off a Child Key » vide et cliquez sur Continue.

Copiez l’URL du webhook fournie par Zapier, collez-la dans votre dashboard Scalingo, puis cliquez sur « OK, I did this ».

Zapier attend maintenant de recevoir une notification.
Retournez sur votre dashboard Scalingo et cliquez sur « Test webhook ».

Action

Pour définir l’action à exécuter lors de la réception d’une notification, choisissez « Email by Zapier », puis l’option « Send Outbound Email ».

Configurez ensuite votre email :

• indiquez le destinataire dans le champ « To »

• utilisez les champs dynamiques (nom de l’app, statut du déploiement, etc.) dans l’objet et le corps du message via « Insert a Field »

Vous pouvez personnaliser le contenu de l’email selon vos besoins.

Et voilà : vous recevez désormais un email de notification généré automatiquement par Zapier !

Bien sûr, ce scénario peut être adapté à de nombreux autres cas d’usage.

Et ensuite ?

Dans un prochain article, nous verrons comment créer un agent simple capable d’écouter les notifications de déploiement, puis d’installer automatiquement l’image Docker de votre application que nous avons générée pour vous.

Et bien entendu, de nouveaux types de notifications seront ajoutés dans le futur.

Restez connectés ! 🚀