Ga naar hoofdinhoud

Webhooks configureren

Alle berichten die zijn gemaakt via Predis.ai API hebben een levenscyclus en nemen verschillende toestanden aan. De mogelijke toestanden die een post kan aannemen zijn inProgress, completed en error. Zodra er een verzoek is gedaan om een ​​bericht te genereren, wordt de inProgress status wordt gemeld in het antwoord zelf. De overige twee staten - completed en error worden op de hoogte gesteld via de door u geconfigureerde webhooks.

Stel een webhook-URL in​

Volg de onderstaande stappen om uw webhook-URL in te stellen in de API dashboard:

  • Log in op Predis.ai gebruiken
  • Navigeer naar Prijzen & Account -> Rest API om de te openen API dashboards
  • Voeg uw webhook-URL toe. Zorg ervoor dat de webhook-URL een openbare URL is.

Webhook-payload​

Als het bericht een completed or error status wordt een webhook verzonden met de payload die de volgende parameters bevat:

completed staat lading

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

error staat lading

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

We sturen de webhook precies één keer voor elk bericht, zelfs als we een niet-succesvol antwoord van uw servers ontvangen. Als uw servers de webhookgebeurtenis niet kunnen verwerken, kunt u de gegevens van al uw gegenereerde berichten opvragen. Lees er meer over hier

Testen in de lokale omgeving​

Het is niet mogelijk om localhost rechtstreeks te gebruiken om webhookstatussen te ontvangen, omdat de webhook-URL een openbare URL moet zijn. U kunt dit aanpakken door een tunnel naar uw lokale server te maken met behulp van tools zoals ngok. Gebruik het URL-eindpunt dat door deze tools wordt gegenereerd in de webhook-URL terwijl u uw webhook-URL instelt in het dashboard.

Aanvullende bronnen​