Skip to main content

Quote Request Attachments

Quote requests may include relevant additional documentation as attachments. You can retrieve these attachments using the Get Attachments API:

  1. If a Quote Request has attachments, you will find them in the "attachments" section in the webhook event payload

    {
    // ...
      "attachments": [
        {
          "id": "d865f3fe-4eb3-421e-b3c0-093b04287505",
          "filename": "quote.pdf",
          "attachment_type": "quote_pdf"
        }
      ]
    // ...
    }

  2. Extract the id from the attachment object in the webhook event and use it to GET the attachment via the authenticated endpoint

    https://partner-engine.boldpenguin.com/attachments/d865f3fe-4eb3-421e-b3c0-093b04287505

  3. The response from the API will be the binary attachment you can store or display to the end user