Tracking case file usage

How to implement tracking of case files

When building an integration, you might have a need to track where your case files originate, who created it, or any other associated data that you wish to record. Especially if you manage multiple integrations and/or customers.

We recommend using the metaData parameter when creating case files. This field allows you to tag each case file with a custom identifier, enabling you to filter, sort, and report on case files based on their origin.

1. Tagging the case file
   When calling the create a new case file endpoint , populate the metaData field with a structured string that identifies the integration source or with a structured string meaningful for your desired purpose.

Example of adding metaData on a case file

{
  "caseFile": {
    "title": "<insert casefile name>",
		"metaData": "Penneo-{CustomerName}-{SystemSource}",
    "signers": [
      {
        "name": "<enter signer name>",
        "email": "<enter signer email>"
      }
    ],
    "documents": [
      {
        "name": "<name of the file>",
        "title": "<enter a document title>"
      }
    ]
  }
}

2. GET a list of your case files
   Once implemented you can GET a list of all your case files. Use the output to perform your analysis.

As always, feel free to reach out to our support team if you have any additional questions.