Guide d’intégration

Configurer les webhooks de Rank Prompt

Fini le polling. Rank Prompt appelle votre point de terminaison dès qu’un rapport ou une exécution programmée se termine, ou échoue, avec une charge utile signée à laquelle votre serveur peut se fier.

Commencer gratuitement Découvrir la fonctionnalité
Webhooks

Rank Prompt lit

  • Le code de réponse de votre point de terminaison

Rank Prompt envoie

  • Type et identifiant de l’événement
  • Charge utile du rapport ou de l’exécution
  • Signature HMAC
  • Identifiant de livraison
Rank Prompt

Ce que ça fait

  • Envoie report.completed, report.failed, schedule.run.completed et schedule.run.failed à votre point de terminaison, par marque.
  • Signe chaque livraison en HMAC pour que vous puissiez prouver qu’elle vient de Rank Prompt.
  • Relance une livraison échouée après 30 secondes, 2 minutes, 10 minutes, 1 heure, 6 heures et 24 heures.
  • Fait tourner le secret de signature sans interruption et désactive un point de terminaison après 20 échecs d’affilée.
  • Publie aussi dans Slack ou Discord : choisissez le type de destination et chaque événement arrive sous forme de message écrit pour le canal.
  • Abonne aussi un endpoint de marque aux événements d’articles : article.published, article.updated et article.unpublished.
  • Envoie une livraison de test à la demande, signée comme une vraie, avec la réponse et la durée affichées.

Avant de commencer

Forfait Dès Starter

  • Un point de terminaison HTTPS public sur votre serveur, qui répond vite avec un code 2xx.
  • Un endroit sûr pour le secret de signature, comme votre gestionnaire de secrets.
  • Jusqu’à 5 points de terminaison actifs par marque.
Configuration

Webhooks : configuration en 4 étapes

  1. Étape 1

    Ouvrir Développeurs, Webhooks

    Dans Rank Prompt, ouvrez Développeurs, choisissez l’onglet Webhooks et la marque.

    L’onglet Webhooks de la page API développeurs, avec le choix de la marque et le bouton Nouveau webhook.

  2. Étape 2

    Ajouter votre point de terminaison

    Cliquez sur Nouveau webhook, saisissez l’URL https et choisissez les événements qu’il doit recevoir.

  3. Étape 3

    Conserver le secret de signature

    Copiez le secret sur votre serveur. Chaque livraison porte X-RP-Signature avec un horodatage et une signature v1 ; recalculez-la sur le corps brut et comparez.

  4. Étape 4

    Traiter les livraisons

    Répondez vite avec un 2xx, puis faites le travail. Utilisez X-RP-Event-Id pour ignorer une nouvelle tentative déjà traitée.

Dépannage

Webhooks : erreurs et solutions

Voici les messages que l’app affiche, mot pour mot, et ce qui résout chacun d’eux.

  • Le maximum de 5 webhooks actifs par marque a été atteint.

    Désactivez ou supprimez un point de terminaison que vous n’utilisez plus, ou envoyez plusieurs types d’événements vers un même point de terminaison.

  • Nous avons désactivé le webhook de Mercari (JSON signé, b3f1c2d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d) après 20 échecs de livraison consécutifs. Corrigez le point de terminaison, puis réactivez-le pour reprendre les événements.

    Faites de nouveau répondre le point de terminaison en 2xx, puis réactivez-le dans l’onglet Webhooks. Les livraisons abandonnées peuvent y être renvoyées.

Toutes les intégrations

FAQ

Questions fréquentes : Webhooks

Encore des questions ? Contactez notre équipe

À quels événements puis-je m’abonner ?

report.completed, report.failed, schedule.run.completed et schedule.run.failed, plus article.published, article.updated et article.unpublished, par marque. Avec Agency Plus, le propriétaire du compte peut aussi créer des points de terminaison au niveau du compte pour lead.created, lead.report_ready, lead.report_failed et lead.claimed, dans Developers, Webhooks, sous Compte (/developers?tab=webhooks&scope=account).

Que se passe-t-il si mon point de terminaison est hors service ?

La livraison est relancée six fois sur environ une journée : après 30 secondes, 2 minutes, 10 minutes, 1 heure, 6 heures et 24 heures. Après 20 échecs consécutifs, le point de terminaison est désactivé jusqu’à ce que vous le réactiviez.

Comment vérifier une livraison ?

Recalculez le HMAC de l’horodatage et du corps brut avec votre secret de signature et comparez-le à la signature de X-RP-Signature. La documentation développeurs fournit le code.

De quel forfait ai-je besoin ?

Les webhooks commencent avec Starter à 49 $ par mois, ou sont inclus dans un forfait API autonome.

Puis-je envoyer des événements vers Slack ou Discord ?

Oui. Choisissez Slack ou Discord comme type de destination et collez l’URL du webhook entrant du canal : chaque événement arrive sous forme de message pour ce canal, dans la langue du propriétaire.

Comment tester un endpoint ?

Cliquez sur Envoyer un test sur l’endpoint. Le test est signé comme une vraie livraison, porte test: true, ne compte jamais pour la désactivation automatique et affiche la réponse et la durée de votre endpoint. Un Replay depuis le journal des livraisons envoie une nouvelle livraison avec un nouvel identifiant de livraison et le même identifiant d’événement et corps que la première.

Est-ce ainsi que je publie des articles vers Zapier ou Make ?

Non, c’est le rôle de la destination webhook : elle envoie l’article entier, signé, à la publication, et enregistre où il est en ligne. Les webhooks d’ici préviennent vos outils qu’il s’est passé quelque chose.

Opérationnel en quelques minutes

Créez un compte gratuit, suivez les étapes ci-dessus et voyez ce que la connexion apporte à votre visibilité IA.

Commencer gratuitement Voir les tarifs