Setting a custom path in the widget metadata.json is currently not possible, here is the feature request for that: https://bugs.kde.org/show_bug.cgi?id=509896
So while you can ship a custom icon and display it when the widget is added to the panel/desktop (using Kirigami.Icon), other places like the widget explorer or the widget about page need an icon that is on the icon theme.