Skip to main content
La ressource Webhooks permet d’enregistrer et de gérer les points de terminaison de vos webhooks par programmation. Vous pouvez l’utiliser dans le parcours de configuration d’une intégration, par exemple pour enregistrer automatiquement une URL de réception lorsqu’un utilisateur installe votre application.
Pour comprendre les types d’événements, le contenu des notifications et la vérification des signatures, consultez le guide des webhooks.

Points de terminaison


GET /webhooks — Lister les webhooks

Renvoie les points de terminaison des webhooks enregistrés dans le projet.

Exemple de requête

Exemple de réponse


POST /webhooks — Créer un webhook

Enregistre un webhook. Amply envoie ensuite une requête HTTP POST à l’URL choisie lorsqu’un des événements suivis se produit.

Paramètres du corps

string
required
URL HTTPS complète à laquelle Amply doit envoyer les notifications, par exemple https://my-server.com/amply-hook.
array
required
Tableau des types d’événements à suivre. Exemples : event.created, event.updated, event.deleted, article.published, place.created.
string
Secret facultatif utilisé pour signer les notifications avec HMAC. S’il est renseigné, Amply ajoute un en-tête X-Amply-Signature à chaque envoi pour vous permettre de vérifier son authenticité. Le secret est renvoyé uniquement dans la réponse à cette requête et ne peut pas être récupéré ensuite.

Exemple de requête

Conservez le secret de votre webhook comme un mot de passe. Il est renvoyé une seule fois, dans la réponse à cette requête POST. Si vous le perdez, supprimez le webhook et créez-en un nouveau avec un autre secret.