run_end Webhook event

[austinwbest]

Had some conversation with Soh on discord so im going to move the thoughts to a GH issue as requested so we dont lose track of them.

So currently the payload is

1:34:50 [INFO] api/index.php LN: 518 :: [event] => run_end
[start_time] => 2024-08-09 13:13:40
[end_time] => 2024-08-09 13:34:51
[run_time] => 0:21:11
[collections_created] => 1
[collections_modified] => 0
[collections_deleted] => 1
[items_added] => 128
[items_removed] => 0
[added_to_radarr] => 0
[added_to_sonarr] => 0
[names]
	[0]
		[name] => Newly Released
		[library] => Movies
	[1]
		[name] => Newly Released
		[library] => TV Shows
	[2]
		[name] => New Episodes
		[library] => TV Shows
[library_mapping_name] => 

But we need some clarification and maybe a few new fields :)

Clarification:
what is "names" as it is 3 items that i dont see relate to any other numbers (is it a bug of counting the collection stuff?)
what is "items_added" in reference to, as in what is an "item"
collections_created|modified|deleted, what are they? maybe we can add those in there so users can see them

New:

• collection_changes: {created: []. modified: [], deleted: {}}

overlays_created|modified|deleted, curious about a stat amount for this

• overlay_changes: {created: []. modified: [], deleted: {}}

I would like to adjust some of the other things for structure purposes but im afraid that might break things for unknown people who consume this so i'll leave that stuff out for now.

[bullmoose20]

@chazlarson - are you able to answer some of these questions for nitsua?

[chazlarson]

Just kind of guessing:

what is "names" as it is 3 items that i dont see relate to any other numbers (is it a bug of counting the collection stuff?)

Looks to me like it's an [arbitrarily?] numbered list of collections/libraries.

	[0]
		[name] => Newly Released
		[library] => Movies

"Newly Released" collection in the "Movies" library

Kometa libraries might be "virtual" libraries with arbitrary names that are pointed at Plex libraries, that's probably what this is after:

	[2]
		[name] => New Episodes
		[library] => TV Shows
                 [library_mapping_name] => Something Else

I'm not seeing how those names are tied back to what happened to that thing.

what is "items_added" in reference to, as in what is an "item"

A movie, show, episode; whatever a given collection is composed of, or an overlay is applied to.

collections_created|modified|deleted, what are they? maybe we can add those in there so users can see them

I imagine "This run created 12 collections, modified 2 collections, deleted 724 collections"

Same with overlays.

[austinwbest]

Yea, if the items is just an arbitrary number then i think it would be much better to add collections and overlay numbers to an object for clarity especially but more so for the added info

{
.....
    collection_changes: {
        created: 1. 
        modified: 2, 
        deleted: 3
    },
    overlay_changes: {
        created: 1. 
        modified: 2, 
        deleted: 3
    }
.....
}

[jtitley]

If there is going to be changes to webhooks, is this the place to request some sort of app title? I have alerts onto one Telegram channel. It's obvious that it's kometa since it's the only one that doesn't have an app title. But it would be nice. For example Watchtower will put in bold "Watchtower updates on xxx" and then the next line is the message.

Or else some sort of way to configure or template the message and leave it up to the user to configure.

Sorry to hijack, I thought since this is a recent conversation around webhooks, it seemed relevant.

Otherwise, I have to say kometa transformed my Plex experience, thank you!

[austinwbest]

This is geared towards notifiarr consuming the webhook (not sure how telegram works with this, a template or something I guess) so might get more traction with a telegram specific thread