[Archivesspace_Users_Group] Web hooks or triggers on record update

[Alan Manifold]

Thanks, Brian and also thanks to Kevin Clair for this tip. It's very helpful and I'm currently exploring what kind of results we get from it.

Regards,
Alan




Alan Manifold | Library Systems & Digital Preservation Manager | Collection Development & Description
State Library Victoria | 328 Swanston Street | Melbourne VIC 3000
T +61 3 8664 7122 | amanifold at slv.vic.gov.au
slv.vic.gov.au<http://slv.vic.gov.au>

 [slv]

[https://www.slv.vic.gov.au/sites/default/files/email_signature/signature.jpg?9]<https://www.slv.vic.gov.au/email_campaign>


From: archivesspace_users_group-bounces at lyralists.lyrasis.org <archivesspace_users_group-bounces at lyralists.lyrasis.org> On Behalf Of Brian Hoffman
Sent: Wednesday, May 10, 2023 5:02 PM
To: Archivesspace Users Group <archivesspace_users_group at lyralists.lyrasis.org>
Subject: Re: [Archivesspace_Users_Group] Web hooks or triggers on record update

Hi Alan,

There is an endpoint that provides a stream of updated records:

http://archivesspace.github.io/archivesspace/api/#get-a-stream-of-updated-records

It is there to enable the indexer to do its work, but perhaps it would work for your use case.

There is a window during which records can show up in the feed (60 seconds by default) and records in the feed will have a 'sequence' attribute. If you make a subsequent request with a 'last_sequence' parameter that is equal to or greater than the highest sequence in the feed, the api will block (not respond) until a new update appears or the request times out.

The records in the feed don't have any information about what date was updated.

Brian

From: archivesspace_users_group-bounces at lyralists.lyrasis.org<mailto:archivesspace_users_group-bounces at lyralists.lyrasis.org> <archivesspace_users_group-bounces at lyralists.lyrasis.org<mailto:archivesspace_users_group-bounces at lyralists.lyrasis.org>> on behalf of Alan Manifold <amanifold at slv.vic.gov.au<mailto:amanifold at slv.vic.gov.au>>
Date: Wednesday, May 10, 2023 at 1:52 AM
To: archivesspace_users_group at lyralists.lyrasis.org<mailto:archivesspace_users_group at lyralists.lyrasis.org> <archivesspace_users_group at lyralists.lyrasis.org<mailto:archivesspace_users_group at lyralists.lyrasis.org>>
Subject: [Archivesspace_Users_Group] Web hooks or triggers on record update
Hi ArchivesSpace community,
We're thinking of a few projects that could benefit from something like a webhook or a trigger when specific records are updated. For example, when an archival object record is edited, it could trigger a custom script that could update metadata in our digital asset management system. Or when a record is unpublished, it could trigger a custom script that would add an event record.

I haven't found any indication that such functionality exists, but I'm not an expert, so I'm asking. If it doesn't exist, is this something you think your institution might be able to use as well? If you are a developer, do you think it would be difficult or easy to add this to the product, either as an enhancement or as a plugin just for our site?

Any thoughts would be welcome!

Regards,
Alan Manifold



Alan Manifold | Library Systems & Digital Preservation Manager | Collection Development & Description
State Library Victoria | 328 Swanston Street | Melbourne VIC 3000
T +61 3 8664 7122 | amanifold at slv.vic.gov.au<mailto:amanifold at slv.vic.gov.au>
slv.vic.gov.au<http://slv.vic.gov.au>

 [Image removed by sender. slv]
[Image removed by sender.]<https://www.slv.vic.gov.au/email_campaign>



This message and any attachment is intended only for the use of the Addressee and may contain information that is PRIVILEGED and CONFIDENTIAL. If you are not the intended recipient, you are hereby notified that any dissemination of this communication is strictly prohibited. If you have received this communication in error, please delete all copies of the message and its attachments and notify the sender immediately. Thank you.
This message and any attachment is intended only for the use of the Addressee and may contain information that is PRIVILEGED and CONFIDENTIAL. If you are not the intended recipient, you are hereby notified that any dissemination of this communication is strictly prohibited. If you have received this communication in error, please delete all copies of the message and its attachments and notify the sender immediately. Thank you.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lyralists.lyrasis.org/pipermail/archivesspace_users_group/attachments/20230510/c97d4863/attachment.html>