How to hook into the Lead audit log

peter_k · January 17, 2024, 5:43pm

Hey there,

I would like to show data in the lead’s audit log (/contacts/auditlog/{leadId}).

It seems that the audit log offers no way to hook into.

LeadBundle/Controller/AuditlogController.php fetches the audit log events from via the LeadDetailsTrait.
The trait fetches the log events from the AuditLogRepository.
AuditLogRepository::getAuditLogs() has hard coded database call.

The devdocs only mention hooking into the history.

Is there a way? If so, how?

Kind regards

escopecz · January 18, 2024, 7:58am

You can listen for the LeadEvents::TIMELINE_ON_GENERATE event. Almost all bundles and plugins do so if you’d like more examples:

github.com

mautic/mautic/blob/a8c2f81324462f73d4192ab19dc43890683d2e7e/app/bundles/AssetBundle/EventListener/LeadSubscriber.php#L28


      
              private AssetModel $assetModel,
              private TranslatorInterface $translator,
              private RouterInterface $router,
              private DownloadRepository $downloadRepository
          ) {
          }
          
          public static function getSubscribedEvents(): array
          {
              return [
                  LeadEvents::TIMELINE_ON_GENERATE => ['onTimelineGenerate', 0],
                  LeadEvents::CURRENT_LEAD_CHANGED => ['onLeadChange', 0],
                  LeadEvents::LEAD_POST_MERGE      => ['onLeadMerge', 0],
              ];
          }
          
          /**
           * Compile events for the lead timeline.
           */
          public function onTimelineGenerate(LeadTimelineEvent $event): void
          {

peter_k · January 18, 2024, 6:04pm

Thanks for your reply.

I had a short look into the LeadEvents::TIMELINE_ON_GENERATE event. I figured it lets you only hook into the contact’s history “log”, but not into the audit log (marked in the screenshot):

Am I mistaken?

escopecz · January 19, 2024, 9:57am

Oh, in that tab. It shows all audit log entries that are in the audit_log table for that contact, right? Why don’t you just store the information you want to see there in that table?

peter_k · January 19, 2024, 10:54am

I do.

…	bundle	object	object_id	…
…	lead	myplugin	462	…

I guess, since object!=lead the entry isn’t picked up. Hence, I asked how to hook into this page/table.

escopecz · January 19, 2024, 11:52am

Well, of course. Your row must fit the where conditions as you mention in the forum post:

github.com

mautic/mautic/blob/a8c2f81324462f73d4192ab19dc43890683d2e7e/app/bundles/CoreBundle/Entity/AuditLogRepository.php#L56


      
           * @param int $page
           * @param int $limit
           *
           * @return array
           */
          public function getAuditLogs(Lead $lead, array $filters = null, array $orderBy = null, $page = 1, $limit = 25)
          {
              $query = $this->createQueryBuilder('al')
                  ->select('al.userName, al.userId, al.bundle, al.object, al.objectId, al.action, al.details, al.dateAdded, al.ipAddress')
                  ->where('al.bundle = \'lead\'')
                  ->andWhere('al.object = \'lead\'')
                  ->andWhere('al.objectId = :id')
                  ->setParameter('id', $lead->getId());
          
              if (is_array($filters) && !empty($filters['search'])) {
                  $query->andWhere('al.details like \'%'.$filters['search'].'%\'');
              }
          
              if (is_array($filters) && !empty($filters['includeEvents'])) {
                  $includeList = "'".implode("','", $filters['includeEvents'])."'";
                  $query->andWhere('al.action in ('.$includeList.')');

It should only show changes to the lead object. If it’s related to another object then it shouldn’t show up in the lead audit log. I’d re-consider if the entry shouldn’t show up in the timeline as that’s where all events related to the contact show up. But you know better what your use case is.

peter_k · January 19, 2024, 12:54pm

Gotcha. I had a wrong conception of the audit log.

I’ll figure out if a timeline entry is more fitting or changing this to lead event type, so it shows up in the audit log.

system · January 21, 2024, 12:54am

This topic was automatically closed 36 hours after the last reply. New replies are no longer allowed.

Topic		Replies	Views
Two Plugins Listening for Changes on a Contact Development development , integrations-plugins	4	332	July 28, 2022
Lead view Subscriber Development	1	325	October 17, 2019
Last active?! Product Support	11	499	September 30, 2017
Audit log and user access Product Support	4	610	July 25, 2023
Lead events filter not work Product Support	2	306	January 17, 2017

How to hook into the Lead audit log

Related topics