Quickly get an overview of the terms we use here at Greenspark.
| Term | Definition |
|---|---|
| Custom Integration | With a Custom Integration you can easily differentiate the Impacts you created when using the Greenspark API and simplify reporting. Example: you can create separate Custom Integrations for every application that you connect with the Greenspark API. |
| Sources | Part of a Custom Integration, a Source is the first level to differentiate Impacts. It holds the name and id for the Custom Integration. Example: you can store the connected application name as a source name. |
| Triggers | Part of a Custom Integration, a Trigger is the second level to differentiate Impacts. It holds a name and a type. Available types: - transaction - subscription - order - subscriber - review - affiliate - partner - form completion - other Example: you can associate triggers with actions within your connected application and quickly segment data. If you want to create an impact for every review, you can choose the review trigger type. |
| Impact | You can create an impact through the Greenspark API that will be associated with a source and trigger. An impact consist of one or more Impact Purchase objects and optional Metadata. An Impact Purchase holds a type (trees, plastic, carbon) and the amount you want to purchase. You can provide Metadata as an array of string key-value pairs, which will be associated to your Impact. This allows you to further segment data by for example attributing an Impact Purchase to a specific user within your application. |
| Tailored Impact | A Tailored Impact is an Impact without any associated source and trigger. This kind of Impact will be associated with your account. An impact consist of one or more Impact Purchase objects and optional Metadata. An Impact Purchase holds a type (trees, plastic, carbon) and the amount you want to purchase. You can provide Metadata as an array of string key-value pairs, which will be associated to your Impact. |