Logo

PDFBlaze

Notifications

Post-generation actions

PDFBlaze offers two types of notifications: email and webhook. Notifications are sent after a PDF has been generated. Generation jobs are always grouped and won’t send notifications for individual PDFs. For example, if you generate 10 PDFs in a single job, you will receive a single notification for all 10 PDFs once they are complete and ready for download instead of an individual notification for each PDF. The notification settings are found in the “Settings” tab of the document editor.


The settings page showing the notification settings

Email notifications

A notification email will be sent to your registed email address once a job is completed. A job is only marked as completed once all values have been processed. The email will contain a summary of the job and a link to download the PDFs. You can use this to keep track of the PDF generation status and download the PDFs once they are ready. The email will be sent once the job is complete and ready for download.


Email notifications can only be sent to the email address associated with your account. Every user in the workspace will need to subscribe to emails individually if required. If a more programmatic approach is required, we recommend using webhook notifications instead.


Webhooks

The webhook notification allows you to send a POST request to a URL of your choice with the job details. The POST request will contain the job details in JSON format. You can use this to integrate PDFBlaze with your own systems or services. The webhook will be sent once the job is complete and ready for download. You can use the webhook to trigger other actions or services based on the PDF generation status.


The payload of the webhook is as follows:

{
  "groupId": "string",
  "results": [
    {
      "status": "success | error",
      "url?": "string"
    }
  ]
}

An example of a webhook payload:

{
  "groupId": "123456",
  "results": [
    {
      "status": "success",
      "url": "https://pdfblaze.com/download/123456/example.pdf"
    },
    {
      "status": "error",
    }
  ]
}

Errors in generation while generally rare can occur. If an error occurs during generation, the webhook will still be sent, but the status will be “error” and the URL will be omitted. You can use the webhook to trigger other actions or services based on the PDF generation status. The webhook will be sent once the job is complete and ready for download.