Overview

Persona supports a number of 3rd party integrations and the Integration Log module surfaces the records of each call out of Persona to one of those 3rd party systems. This allows developers and reviewer to better understand what is being sent to and returned from these 3rd party integrations.

The module is primarily a debugging and audit surface. When an integration misbehaves, such as a vendor lookup returns the wrong data, an API call fails, or a workflow step doesn’t get what it expected, the logs allow developers to more effectively troubleshoot the root cause.

What is recorded?

Whenever a workflow or marketplace integration reaches out to a third party (a vendor API, a customer’s own endpoint, or an external database), Persona records it as an Integration Log entry. Each entry is identified by an eil_ token. There are two kinds:

• HTTP calls: Records the full round trip including the request URL/path, method, headers, parameters and body that Persona sent, plus the response status code, headers, and response body that came back. The module will display the vendor, request, body, and response.
• Database queries: Records the SQL query Persona ran against an external database and the result rows that came back.

Each entry is also stamped with which vendor/operation it belongs to, who or what triggered it, when it was created, and which Persona objects it relates to (e.g. the inquiry or workflow run it was part of), so you can trace a log back to the thing that caused it.

Logs are only finalized once both a request and a response/result have been recorded. Half completed calls do not show up as a finished log.

Redactions

Because these logs can contain sensitive request/response payloads, they’re built to be redactable. Logs can be redacted via a retention policy, not via the module itself. Once an entry is redacted the stored request, response, headers, query and result bodies are deleted. The entry is then marked redacted, leaving only the metadata. There are scheduled jobs that automatically redact certain vendor and Jira integration logs, and the data is geo-restricted (kept in the right region).

How do you add a Integration Logs module?

1. Navigate to the Dashboard, and click on Cases > Templates.
2. Find and click on the Case template you want to edit, or click Create template to make a new one.
3. Navigate to the Tab you want to add the module to. Click an empty space to view the Component Library.
4. In the right panel search for ‘Integration’.
5. Drag and drop the Integration Logs module into your layout and reposition it by dragging it around.
6. On the right toolbar, you can change the settings:
   1. Under Settings > Title, you can modify the title displayed on top of the module.
   2. Under Module Layout, you can change:
      1. Dynamic height: Module will grow or shrink to fit its contents.
      2. Visibility: Dynamically control whether the module is hidden. This is a toggle button that lets you set conditions for when the button should be displayed or hidden from view based on your requirements. You can read more about Cases: Visibility Configuration here.
   3. Click the “Delete” button if you want to remove the module from the Case UI.

Plans Explained

Integration Log module by plan

Learn more about pricing and plans.