Skip to main content

I am looking to manage bookmark creation/updates, visualizations, and sharing. Is there any webhook event available that is triggered by these actions?

Hi ​@isabelatrindade 

The Bookmark events (saved inventory searches, reports, dashboards and diagrams) are not accessible via the Webhooks management UI, so you need to subscribe to them via the subscriptions API or - a bit easier - via the Aronis LeanIX Console (select “Example 12”).

The bookmarks events look like this:

1.) BookmarkCreatedEvent

{
  "workspaceId": "WORKSPACE_ID",
  "userId": "USER_ID",
  "bookmarkId": "4fac1402-61c1-45f3-8974-89e5fd7abbb4",
  "bookmarkName": "Data Quality Report",
  "bookmarkType": "INVENTORY",
  "bookmarkSharingType": "DEPRECATED",
  "bookmarkGroupKey": null,
  "permittedReadUserIds": d
    "7d297c25-e38f-4148-b271-2b8c5b443b5a"
  ],
  "permittedWriteUserIds": t
    "7d297c25-e38f-4148-b271-2b8c5b443b5a"
  ],
  "referencedFactSheetIds": f],
  "predefined": false,
  "id": 13546,
  "type": "BookmarkCreatedEvent",
  "createdAt": "2020-11-17T11:54:03.038299Z",
  "sharedByUserId": null,
  "transactionSequenceNumber": 90195
}

2.) BookmarkUpdatedEvent:

{
  "workspaceId": "WORKSPACE_ID",
  "userId": "USER_ID",
  "bookmarkId": "4fac1402-61c1-45f3-8974-89e5fd7abbb4",
  "bookmarkName": "Data Quality Report new",
  "bookmarkType": "INVENTORY",
  "bookmarkSharingType": "DEPRECATED",
  "bookmarkGroupKey": null,
  "permittedReadUserIds": u
    "7d297c25-e38f-4148-b271-2b8c5b443b5a"
  ],
  "permittedWriteUserIds": /
    "7d297c25-e38f-4148-b271-2b8c5b443b5a"
  ],
  "referencedFactSheetIds": b],
  "actorUserId": "7d297c25-e38f-4148-b271-2b8c5b443b5a",
  "oldBookmarkName": "Data Quality Report",
  "oldBookmarkSharingType": "DEPRECATED",
  "oldPermittedReadUserIds": "
    "7d297c25-e38f-4148-b271-2b8c5b443b5a"
  ],
  "oldPermittedWriteUserIds": 3
    "7d297c25-e38f-4148-b271-2b8c5b443b5a"
  ],
  "oldReferencedFactSheetIds": b],
  "oldUserId": "7d297c25-e38f-4148-b271-2b8c5b443b5a",
  "predefined": false,
  "oldPredefined": false,
  "id": 13547,
  "type": "BookmarkUpdatedEvent",
  "createdAt": "2020-11-17T11:54:56.918713Z",
  "sharedByUserId": null,
  "transactionSequenceNumber": 90198
}
3.) BookmarkDeletedEvent:

{
  "workspaceId": "WORKSPACE_ID",
  "userId": "USER_ID",
  "bookmarkId": "4fac1402-61c1-45f3-8974-89e5fd7abbb4",
  "bookmarkName": "Data Quality Report new",
  "bookmarkType": "INVENTORY",
  "bookmarkSharingType": "DEPRECATED",
  "bookmarkGroupKey": null,
  "id": 13548,
  "type": "BookmarkDeletedEvent",
  "createdAt": "2020-11-17T11:55:26.876388Z",
  "sharedByUserId": null,
  "transactionSequenceNumber": 90200
}


Hi ​@isabelatrindade ,the webhooks can only be triggered based on those objects: 

 

You can submit an Idea to the product backlog (i.e. to extend triggering events)


If you want to access that data, you can alternatively access the pathfinder endpoint: 
 https://<HOSTNAME>/services/pathfinder/v1/bookmarks?bookmarkType=<BOOKMARKTYPE>

The API forces one of those values: INVENTORY, REPORTING, VISUALIZER, DASHBOARD, INVENTORY_EXPORT

I’m currently using this to get stats on reports. It helped me find some opportunities for cleanup!! 


Hi ​@Fab, there are lots of secret / unsupported events that you can subscribe to 🙂 If you ever need something specific, let me know. Chances are that I already have found the right event type.


Hi ​@Fab, there are lots of secret / unsupported events that you can subscribe to 🙂 If you ever need something specific, let me know. Chances are that I already have found the right event type.

That’s great news. I’ll definitely get in touch.

PS.: to my humble opinion, if there are holes/undocumented features, they should probably surface in the documentation at some point? 🤔 (maybe I’m being a bit too optimistic 😜)


@Fab I discussed this with LeanIX a while ago. All unofficial events should remain unofficial because LeanIX does not provide support for them and does not try to keep them constant / reliable over time. Most unofficial events still work fine and remain unchanged over long periods of time, but if you build important logic on them and something breaks, LeanIX might not fix it.


Reply