Skip to content

Print Service

The print service generates PDF renditions of Wombat object instances on the server. It can either return a temporary download URL for the generated file or send the PDF as an email attachment.

Base URL

text
https://app.wombat.software/print

Supported Target Paths

Print routes are target-scoped in the same way as the main API. When you see {targetPath} in the endpoint docs, it can be any of the following:

target typepath
Site/site/:siteId
Tenant/tenant/:tenantId
Tenant Division/tenant/:tenantId/division/:divisionId
Organization/organization/:orgId
Organization Tenant/organization/:orgId/tenant/:tenantId
Organization Tenant Division/organization/:orgId/tenant/:tenantId/division/:divisionId

See API Target for the shared target-path conventions used across Wombat services.

Authentication

The print service uses the same authenticated request flow as the rest of the platform. Send credentials in the Authorization header:

  • Authorization: Bearer <firebase-id-token>
  • Authorization: Basic <base64(email:password)>

See Authentication for the platform authentication overview.

Permissions

Requests require any one of the following permissions on the targeted org, tenant, division, or site:

  • READ
  • MANAGE_FORM
  • MANAGE_OBJECTS
  • ADMIN

Common Response Shape

Successful responses are returned as JSON with a message and data payload:

json
{
  "message": "Human-readable status message",
  "data": {}
}

POST /print/{targetPath}/print returns 201 Created on success.

POST /print/{targetPath}/send-pdf returns 200 OK on success.

Service Notes

  • Generated files are written to the target storage bucket under a generated-pdfs/ path.
  • Download URLs are signed for 15 minutes outside the emulator.
  • The current server handlers document and validate objectInstanceId as the printable resource identifier.