Supported technology/wpsWatch
| Type | Push integration |
| Direction | Data provider |
The Gundi Integration allows wpsWatch to post images to one or more EarthRanger sites, or other outbound destinations. To configure an integration, you will need:
- Access to a Workspace in Gundi. This can be requested by contacting our Support Team.
-
When EarthRanger is the destination:
- An existing Destination in Gundi, or
- Admin access to the EarthRanger instance.
- System Admin access to wpsWatch (WPS staff only)
What you'll receive
We add details here as we confirm what wpsWatch sends. If you know something we're missing, let us know.
| Positions | No |
| Alerts and events | Yes. Camera trap events with their tags. See wpsWatch Event Type. |
| Sensor readings | No |
| Photos and files | Yes |
| Past data | Not documented yet |
How this integration works
This is a push integration. The data provider sends data to Gundi whenever it has something new, on its own schedule. Gundi passes each piece on to your destination as soon as it arrives.
Who's involved
- You create the Route in Gundi and share its API key with the data provider.
- The data provider turns on sending to Gundi with that key.
- Your destination, for example EarthRanger, is where the data shows up.
- Gundi support helps only when the setup badge at the top of this page says so.
Historical data
Gundi passes on whatever the provider sends, old or new. Gundi can't ask the provider for past data, so if you need history, ask the provider whether they can send it again.
When data doesn't show up
Gundi doesn't check the provider for new data; it waits for the provider to send it. If nothing arrives, check with the provider first that they are sending, then look at your Route Activity Logs.
How often data arrives
That depends on how often the provider sends it. Some send each reading right away, others in batches every few minutes or hours.
Integration Process Summary
EarthRanger
-
Update the Camera Trap Event Type
schema in EarthRanger
-
Create a user in EarthRanger with permissions to post Events and a long-lived token for that
user. Read more
.
Gundi
- Create a Route in Gundi.
wpsWatch
- Edit the integration in the wpsWatch site to enable the Gundi integration.
- Update the alert configuration(s) in wpsWatch to send the alerts to Gundi.
- Validations.
Configuration
GUIDES
1. Gundi Connection Settings
1.1 Visit our portal.
1.2 On the Routes page, click Create Route.
1.3 Under What would you like to connect?, search for your technology, select it and click Next.
1.4 Under Route details, enter a Route Name (e.g., “TechnologyName - AreaName”).
1.5 Choose the Route Workspace.
1.6 Click Create Route. Gundi creates the Route and opens its flow map.
1.7 Click Add destination on the flow map and select a destination. Please consult our guides.
1.8 Click the data provider node on the flow map and open Connect → Push API key.
Under API key, click the copy
icon. Only workspace admins can see and copy the key.
1.9 Under Send data to this Route, choose what the provider will send (Observations, Events or Events with attachments) and copy the Endpoint. Send the API key, the endpoint and your account identifier to your contact at the data provider, and ask them to set up an integration with Gundi. If you have access to their system, you can enter these settings there yourself.
Suggested Contacts:
- Tom Coetzee (tom.coetzee@wildlifeprotectionsolutions.org)
WPS Staff will help you with the following actions:
- Edit the Integrations in the wpsWatch site to enable the Gundi integration with the URL and API Key.
- Update the alert configuration(s) in wpsWatch to send the alerts to Gundi.
- Validations.
2. Configurations in wpsWatch
2.1 Edit your integrations in wpsWatch.
- Log into wpsWatch as a System Admin and navigate to Site Details.
- Go to Actions > Edit Integrations
- Check Gundi In the Outbound Integrations section
-
The Base URL should automatically be populated with the appropriate Gundi
URL:
https://sensors.api.gundiservice.org/v2/events/ - In the API Key field, enter the API Key you copied from Gundi.
- Click Save to enable the integration
2.2 Update the alert configuration(s) in wpsWatch to send the alerts to Gundi
- From Site Details, go to Actions > Configure Alerts
- Depending on the conditions where you want to send alerts to EarthRanger, you can either create a new alert configuration or edit an existing one.
- Specify whatever criteria you want to trigger the alerts, and check the Send Notification to Gundi box in the routing options
- Click Save.
2.3 Validation
When a photo is tagged in wpsWatch (by the AI or manually) that meets the criteria of the alert configuration you created above, wpsWatch sends the event to Gundi. Confirm delivery in both Gundi and EarthRanger:
In Gundi (optional):
- The first time a photo comes in, a new source appears on the Sources tab, along with a Source Created line in the logs.
- A new Observation Delivered event appears in the logs for each photo sent, followed by a second log line for attaching the image to the ER event.
In the destination EarthRanger site:
-
You should see a new camera trap event. With the V2 integration, the event now includes the
following additions:
- The event name includes the deployment name and a list of the unique tags from the photo.
- An array of tag information, including a count of each tag.
- The battery level, if it is available in wpsWatch.
- A unique list of tags stored on the event. This list is not displayed in the ER UI but is included in exported events for reporting purposes.
Considerations
- This integration does not currently include event updates. If a ‘rhino’ tag is added to the photo in wpsWatch, that tag won’t be added to the event in ER.
- An integration with Cmore is in the roadmap, but not yet available.
- The array of tags isn’t reportable in ER, so there’s a separate Tags field that contains a comma-delimited list of tags that can be used for reporting. It isn’t displayed in the UI for the event, but it is included in exports.
Characteristics
This integration is classified as a “Push” type, meaning wpsWatch services send data to Gundi as soon as they process the images. Gundi then immediately attempts to forward the image and metadata to the destination specified in the Connection.
Other wpsWatch
| Sending data to wpsWatch |
| Back to the integration catalog | Need help setting this up? Contact us |
