Guides Editors API Reference Aide
Documentation

Webhooks

Les webhooks vous permettent de recevoir des notifications en temps réel pour des événements spécifiques dans votre compte. Cela peut être utile pour intégrer PDF-API.io à vos propres systèmes ou à des services tiers.

Événements disponibles

Actuellement, l'événement suivant est pris en charge :

  • pdf.created : Déclenché lorsqu'un nouveau PDF est généré à partir de l'un de vos modèles.

Gestion des webhooks

Vous pouvez gérer vos webhooks via l'interface web de PDF-API.io.

Interface web

Pour gérer vos webhooks :

  1. Connectez-vous à votre compte PDF-API.io.
  2. Accédez à la page Webhooks.
  3. Ici, vous pouvez voir les webhooks existants, en créer de nouveaux ou supprimer ceux existants.

Création d'un webhook

Lors de la création d'un webhook, vous devez spécifier les informations suivantes :

  • Événement : Le nom de l'événement que vous souhaitez écouter (par exemple, pdf.created).
  • URL : L'URL où vous souhaitez recevoir la charge utile du webhook.
  • Modèle (facultatif) : Si vous souhaitez recevoir des notifications uniquement pour un modèle spécifique, vous pouvez le sélectionner dans la liste déroulante.

Charge utile du webhook

Lorsqu'un événement se produit, nous enverrons une requête POST à l'URL que vous avez spécifiée avec une charge utile JSON. La charge utile inclura des informations sur l'événement et toutes les données pertinentes.

Pour l'événement pdf.created, la charge utile ressemblera à ceci :

{
  "type": "pdf.created",
  "data": {
    "template_id": "id_du_modèle",
    "pdf": "contenu_pdf_encodé_en_base64"
  }
}

Lorsque le PDF est généré avec le paramètre de sortie défini sur "url", la charge utile sera légèrement différente. Au lieu d'inclure le contenu PDF encodé en base64, elle fournira une URL où le PDF généré peut être téléchargé. Voici un exemple de la charge utile dans ce cas :

{
  "type": "pdf.created",
  "data": {
    "template_id": "id_du_modèle",
    "url": "https://lien.vers.le.pdf"
  }
}

Dans ce scénario, le champ url contient une URL temporaire où vous pouvez télécharger le PDF généré. Cette URL est valide pour une durée limitée. Assurez-vous de télécharger le PDF ou de le traiter dès que possible après avoir reçu le webhook, car le lien expirera après 15 minutes.

Mécanisme de réessai

Si votre point de terminaison webhook est temporairement indisponible, nous réessaierons d'envoyer la charge utile du webhook jusqu'à 3 fois avec une stratégie de backoff exponentiel.