Passer au contenu principal

Configuration des webhooks

Tous les posts créés via Predis.ai API avoir un cycle de vie et prendre différents états. Les états possibles qu'un message peut prendre sont inProgress, completed ainsi que error. Une fois qu'une demande est faite pour générer une publication, le inProgress L’État est informé dans la réponse elle-même. Les deux États restants - completed ainsi que error sera averti via les webhooks configurés par vos soins.

Configurer une URL de Webhook

Suivez les étapes ci-dessous pour configurer l'URL de votre webhook dans le API tableau de bord:

  • Connectez-vous à Predis.ai appli
  • Accédez à Tarification et compte -> Reste API ouvrir le API tableau de bord
  • Ajoutez l'URL de votre webhook. Assurez-vous que l'URL du webhook est une URL publique.

Charge utile du webhook

Si le message a atteint un completed or error état, un webhook sera envoyé avec la charge utile contenant les paramètres suivants :

completed charge utile d'état

{
"status": "completed",
"caption": "...",
"post_id": "...",
"generated_media": [{"url": "..."}],
"brand_id": "..."
}

error charge utile d'état

{
"status": "error",
"post_id": "..."
}
prudence

Nous enverrons le webhook exactement une fois pour chaque publication, même si nous recevons une réponse infructueuse de vos serveurs. Si vos serveurs ne parviennent pas à gérer l'événement webhook, vous pouvez obtenir les données de toutes vos publications générées. En savoir plus à ce sujet ici

Tests sur l'environnement local

Il n'est pas possible d'utiliser localhost directement pour recevoir les états du webhook, car l'URL du webhook doit être une URL publique. Vous pouvez gérer cela en créant un tunnel vers votre serveur local à l'aide d'outils tels que ngrok. Utilisez le point de terminaison d'URL généré par ces outils dans l'URL du webhook lors de la configuration de votre URL de webhook dans le tableau de bord.

Ressources additionnelles