Registering new Ftrack Actions with Ayon

[noodlewill]

Is there a simple process for adding new custom ftrack actions to register through ayon’s session?

Simply adding the new_action.py file to the actions folder doesn’t seem to work, so I assume there’s another event handler script that needs to be updated before the action is registered?

Also added as an issue for the documentation, Ftrack Actions Documentation - Adding custom actions to ayon #258.

[noodlewill]

So the issue isn’t that it doesn’t register simply, and it actually SHOULD be as simple as putting it in the event_handler_users folder - the issue that was arising was the subtle differences between the entities passed to the action when making a session manually and using the one Openpype makes.

Using entities correctly (as dynamic objects, not dictionaries) fixed all the interaction, launch, and discover steps, and the script runs as intended again.

I think.

[mustafa_jafar]

@noodlewill

the issue that was arising was the subtle differences between the entities passed to the action

Just adding my 2 cents, here are the type hints for the entities argument.

ynput/ayon-ftrack/blob/56d681bc514b79132eedf26dd361335e1cb020e3/client/ayon_ftrack/common/event_handlers/ftrack_action_handler.py#L296-L307

---

To wrap it up:
So, to add a new ftrack action:

1. Simply start development by using the test action as boilerplate.
2. Add your action in ayon-ftrack/client/ayon_ftrack/event_handlers_user folder.
3. Create and upload your custom ftrack addon.