Skip to content

Enhance webhooks documentation - #1500

Merged
skelz0r merged 3 commits into
developfrom
enhance/webhooks
Apr 13, 2026
Merged

Enhance webhooks documentation #1500
skelz0r merged 3 commits into
developfrom
enhance/webhooks

Conversation

@skelz0r

@skelz0r skelz0r commented Apr 13, 2026

Copy link
Copy Markdown
Member
  1. Add test event payload example
  2. Add a button + embed md doc within site
screenshot-2026-04-13--16-53-45--000562

skelz0r added 2 commits April 13, 2026 16:52
Le payload de test (envoyé à la création et lors des tests manuels)
a un format distinct du payload d'événement classique
Le service MarkdownRenderer encapsule la configuration (fenced code
blocks, tables, autolink, TOC anchors) et sera utilisé pour afficher
la documentation des webhooks.
@skelz0r skelz0r self-assigned this Apr 13, 2026
@skelz0r
skelz0r requested a review from JeSuisUnCaillou April 13, 2026 14:54
Rend le fichier docs/webhooks.md en HTML via MarkdownRenderer et
l'affiche sur une page accessible depuis l'index des webhooks (bouton
« Documentation »). La page est accessible sans authentification,
comme la documentation OpenAPI existante.
@JeSuisUnCaillou

JeSuisUnCaillou commented Apr 13, 2026

Copy link
Copy Markdown
Collaborator

Un lien vers les markdown dans github m'aurait suffit, hein, pas besoin de redcarpet là.

M'enfin maintenant que c'est fait 🤷

@skelz0r

skelz0r commented Apr 13, 2026

Copy link
Copy Markdown
Member Author

J'ai hésité mais là on s'assure que c'est une 200 via un test, c'était gratuit

@JeSuisUnCaillou JeSuisUnCaillou left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Je trouve qu'on doit beaucoup scroller avant d'atteindre la partie intéressante en tant que FD qui consomme des webhooks.

Les parties que je mettrai le plus en avant :

  • Sécurité et authentification
  • Implémentation côté récepteur
  • Format des événements et du payload
  • Gestion des échecs et retry

C'est ça que le consommateur veut voir en premier je pense.

Je trouve que Gestion des webhooks via l'interface c'est complètement du blabla, surtout qu'on a déjà fait ce chemin pour arriver à cette doc à priori.

EDIT : j'ai rien dit pour le sommaire.

@JeSuisUnCaillou JeSuisUnCaillou left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

M'enfin c'est déjà une bonne base. Tu peux itérer sur la doc pour mieux prioriser les parties de la doc si tu as le temps.

Met toi à la place d'un intégrateur de webhook : de quoi tu as besoin ? Quel est le TL;DR que tu veux voir ? (ne me répond pas osef je LLM please 🙏 )

@skelz0r

skelz0r commented Apr 13, 2026

Copy link
Copy Markdown
Member Author

Je n'ai pas vraiment changé la doc, juste ajouté un point sur le format de la payload de test (demandé par un intégrateur) + linké pour que la doc soit présente.

Y'a un sommaire pour jump où c'est intéressant, ça me semble pas superflu.

@skelz0r

skelz0r commented Apr 13, 2026

Copy link
Copy Markdown
Member Author

Met toi à la place d'un intégrateur de webhook : de quoi tu as besoin ? Quel est le TL;DR que tu veux voir ?

Pour le coup je trouve que c'est bien architecturé : y'a une intro, le pré-requis, une explication de l'UI, la conception, et enfin l'implémentation. Ça me parait assez standard. Le sommaire est aussi clair si t'as besoin de jump où il faut directement.

@skelz0r
skelz0r merged commit 14898ff into develop Apr 13, 2026
13 checks passed
@skelz0r
skelz0r deleted the enhance/webhooks branch April 13, 2026 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants