faq .sellsy

Webhooks

Chemin : Réglages / Développeurs / Webhooks

Sellsy propose un système de webhook pour optimiser la liaison avec vos solutions.

Lors d’un évènement coté Sellsy (création client, mise à jour document) nous vous donnons la possibilité de déclencher l’envoi d’information de Sellsy vers une URL à configurer par vos soins (à vous de traiter ces données à réception).

Actuellement 2 types de webhooks existent via Sellsy :

  • Webhook Slack
  • Webhook POST

Qui doit mettre en place le webhook sur Sellsy ?

  • Seul un administrateur de votre compte Sellsy, peut configurer les webhooks.Il s’agit de manipulation sensible, tant d’un point de vu technique, que sur le plan de la confidentialité des données.

Configuration du webhook sur Sellsy :

  1. Vous devez vous rendre dans “Réglages / Développeurs / Webhooks”.
  2. Choisissez le webhook à configurer (ex : Slack, POST).
  3. Puis rendez-vous à la section choisie ci-dessous pour finaliser la configuration.

Webhook Slack :

La configuration sur Slack demande aussi d’être administrateur du compte Slack.

Vous devez :

  1. Créer l’url du webhook sur Slack
  2. Puis finaliser la configuration sur Sellsy

1/ Obtenir l’url du Webhook Slack :

1.1/ Connectez-vous à votre compte Slack.

1.2/ Accédez à l’adresse suivante : https://my.slack.com/services/new/incoming-webhook/

1.3/ Vous allez être redirigé vers une URL du type https://votre_pseudo.slack.com/apps/new/XXXXXXXX-incoming-webhooks

1.4/ Choisissez un channel par défaut (cette valeur est obligatoire pour valider l’ajout sur Slack, mais elle sera surchargée sur Sellsy).
Ex : channel “#general” ci-dessous.

1.5/ Cliquez sur “Add Incoming WehHooks integration”.

1.6/ Vous allez ensuite obtenir le “Webhook URL” à utiliser sur Sellsy.

En savoir + :

2/ Finaliser la configuration Slack sur Sellsy :

2.1/ Copier le “Webhook URL” récupéré à l’étape 1.6 ci-dessus

2.2/ Coller le “Webhook URL” sur Sellsy (champ nommé “Endpoint Slack”).

2.3/ Inscrivez le nom channel Slack par défaut (qui va surcharger la valeur de l’étape 1.4 ci-dessus).

2.4/ Choisissez d’activer ou non l’envoi des données sur Slack.

Concernant les informations envoyées au Webhook, vous pouvez choisir un “Channel” propre à chaque action.

Ex :

  • Vous pouvez envoyer les notifications d’ouvertures emails de vos clients sur le channel #email-ouvert
  • Vous pouvez envoyer les notifications de factures créés sur le channel #facture
  • etc …

Voici le type de rendu que vous pouvez obtenir sur Slack :

Webhook POST :

1/ Vous devez ajouter l’URL vers votre script dans la section nommé : Configurer le webhook.

2/ Puis “Endpoint personnalisé”.

3/ Activer le webhook (cochez la case en face de “Webhook Actif ?”).

4/ Sélectionner les actions sur lesquelles vous souhaitez obtenir un retour via le webhook.

Informations utiles vous permettant de visualiser, via la section nommée “Format de retour du webhook” :

  • Un exemple vous permettant de récupérer le contenu POST envoyé par le webhook en PHP.
  • Le contenu du JSON envoyé par le webhook.
  • La liste des types d’objets renvoyé (relatedtype).
  • Le webhook n’attends pas de réponse.
  • Le webhook ne gère pas les erreurs.

Divers :

En savoir + sur les webhooks : https://en.wikipedia.org/wiki/Webhook (en)

Cet article vous a-t-il été utile ?