Service Hooks

Service hooks are used to create custom API endpoints in Vitruvi. When created, a new API endpoint will be available in Vitruvi in the form of a POST API with the path:

https://<my_workspace>.api.vitruvi.cc/api/v1/async_events/integrations/<service_hook_name>

These APIs can then be triggered by an external call by the client or other 3rd party (as long as they have been authenticated first), on by a set schedule, for example, once a week on Mondays at 8am.

Service Hooks are most commonly used to trigger batch data transfers or integrations with other system. For example, at 8am every Saturday, synchronize Vitruvi Design Elements with my GIS tool. Or on the last day of each month, export all my timesheets and make it available on an SFTP site for download.

One limitation of this type of script is that it runs as a background job on the server and does not return any data other than the job ID. These scripts cannot be used to create a custom dataset that gets returned by the API, for example, for building custom reports.