notifications-api icon indicating copy to clipboard operation
notifications-api copied to clipboard

Allow templates to be added and edited via the API

Open rory-wilson opened this issue 1 year ago • 3 comments

For deploying and moving between environments, it would be useful if templates could be edited or created via the REST API (or client) rather than a manual job.

rory-wilson avatar Mar 29 '24 15:03 rory-wilson

Hi Rory,

We are hoping to implement it as a part of API improvements work we just started, but it’s non-trivial, and we decided to build it in 2nd wave of improvements. Managing templates via API will hopefully be built late this year or early next year. We will update everyone through our newsletter when it’s ready.

Your colleague Paul asked if we couldn't simply expose one method, so here is additional context:

This piece of work is more than exposing one method - when we do it, we do it properly - we write the V2 endpoints (that may need some additional validation) AND unit tests, we expose both creating AND updating AND archiving templates via API, AND we implement that for API clients, too, AND we need to write documentation for it all.

CrystalPea avatar May 17 '24 15:05 CrystalPea

We would also like this feature, to allow us to track our message templates in source control.

RichardBradley avatar Jul 01 '24 11:07 RichardBradley

This would also be very useful for the team I work on. We'd love to be able to version control our templates in a Git repository and automate the deployment using CI/CD. This has several benefits:

  • It enables peer review of templates, meaning it is less likely that mistakes or bugs are introduced.
  • If there is data loss (either due to an issue on Notify, or if we accidentally delete data), we are able to restore templates automatically
  • From a security point of view we can minimise access to the portal, as most developers don't need access to it, so it creates unnecessary risk.

Thanks for the great service, keep up the good work 👍

webbgeorge avatar Sep 16 '24 16:09 webbgeorge