Report

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

The Report action generates a report from the system's configured report templates and performs one or more of the following:

  • Attaches the generated file to the parent record
  • Emails the report as an attachment to specified recipients
  • Faxes the report to a specifiec fax number

Key Use Cases

  • Auto-generate claim settlement letters when status changes
  • Email policy certificates to insureds on policy binding
  • Generate inspection reports and attach to work orders
  • Produce loss run reports and email to underwriters
  • Create regulatory filings and store as documentation

Domain Restrictions

No Domain Restrictions — The Report action can be executed on any domain that:

  • Has events configured
  • Has an associated report configured for that domain or joined domains

The action uses the domain record to:

  • Filter the report data (via matchField parameter)
  • Attach the generated file to the record
  • Resolve form tags in email content and file names

Common Domains:

  • Claim
  • Policy
  • Asset
  • Contact
  • Invoice
  • WorkOrder
  • Any custom domain with reports

How It Works

Execution Flow

  1. Report Lookup
    System retrieves the report by reportId.

  2. Data Filtering
    Applies filter based on matchField to scope the report to the current record.

  3. Report Generation
    Renders the report in the specified format (PDF, Excel, Word, etc.).

  4. File Storage (if attachToParent = true)

    • Saves the file to database or S3
    • Creates a File record with metadata (folder, type, status, categories)
    • Associates the file with the parent domain record
  5. Email Distribution (if to is specified)

    • Attaches generated report to email
    • Supports additional file attachments via filters
    • Sends notification with the report
  6. Fax Distribution (if faxNumber is specified)

    • Faxes the generated report with cover page
    • Can attach additional files from a folder
    • Sends disposition notifications
  7. Multiple Distribution Methods
    You can combine attachment + email, attachment + fax, or all three simultaneously.

Path Params
string
required

The Report action can be executed on any domain that has an associated report configured for that domain.

integer
required

This is the primary key (ID) of the specific record that is the subject of the report. This is the record that:
• Triggered the action - The event occurred on this record (e.g., Claim ID 12345 status changed)

• Filters the report data - The matchField parameter scopes the report to this specific record:
    • If generating a "Claim Settlement Letter" report for Claim #12345

    • domainKey: 12345 ensures only data for that claim appears in the report

• Receives the attachment - If attachToParent: true, the generated file is attached to this record (ie, teport file appears in the Files tab of Claim #12345).

• Provides form tag context - Used to resolve dynamic content:
{Claim.ClaimNumber} in the filename resolves using Claim #12345's data
Email subject line with {Claim.Claimant.FullName} pulls from this record

Body Params
parameters
object
required
Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json