Pennsieve Apps
Pennsieve allows users to register apps which can receive notifications and interact with data on the platform
Overview
A Pennsieve App is a type of integration that you can build to interact with and extend the functionality of Pennsieve. You can register a webhook to receive events from datasets in the workspace and/or to authorize the integration to interact with datasets on the platform.
Example use cases for these Pennsieve integrations include:
- Automated notification of events to dataset owners
- Automated processing of data that is uploaded to the platform using an external platform
By default, integrations are not enabled for datasets and you will need to specifically enable the integration for each dataset after the integration is defined to authorize the integration to act on the dataset. There is an option to enable the integration to be enabled for all new datasets prospectively.
Configuration
When setting up a Pennsieve App, the user provides the following information
- An API endpoint that is called by Pennsieve with notifications about events on the platform
- The user selects whether the integration should have 'viewer' or 'manager' permissions on the datasets where the integration is enabled
- The user selects the events the integration wants to track from the list below.
Event categories
| Trigger | Description |
|---|---|
| Metadata | Notifies users of changes to dataset name, subtitle, licences, description, image, references, tags, contributors, collections, or ignore files list |
| Status | Notifies users of all changes to dataset status |
| Records and Models | Notifies users of creating, managing, or removing of metadata models and records |
| Files | Notifies users on creating, managing, or removing files within a dataset |
| Permissions | Notifies users on changes in permissions for a dataset |
| Publishing | Notifies users on all stages of publishing process |
Updated 5 months ago