Configuration reference

Every action's config model lives in app/actions/configurations.py. Each is configured per-connection in the Gundi portal. This page collects every field in one place; the per-action pages add behavioral context.

AuthenticateConfig — auth

Field	Type	Default	Notes
authentication_type	enum: token, username_password	token	Selects which credential fields apply.
token	secret string	—	Used when type is token.
username	string	—	Used when type is username_password.
password	secret string	—	Used when type is username_password.

The ER base URL comes from the integration record, not this config.

ShowPermissionsConfig — show_permissions

Field	Type	Default	Notes
include_subjects_from_subgroups_in_parent	bool	True	Include sub-group subjects when listing a parent group's subjects.

PullEventsConfig — pull_events

Field	Type	Default	Notes
start_datetime	ISO-8601 string	required	First-run window start (applies to filter_date_field). Ignored once the watermark advances.
end_datetime	ISO-8601 string	none	Optional window ceiling; sent every run.
filter_date_field	enum: updated_at, created_at, event_time	updated_at	Which ER timestamp the window applies to.
force_run_since_start	bool	False	Reset the watermark for one run.
event_types	list[str]	[]	ER event-type slugs. Empty = no filter.
event_categories	list[str]	[]	ER event-category slugs (AND-combined with types). Empty = no filter.
include_attachments	bool	False	Forward files attached to ER events (photos, documents) to Gundi as event attachments. Off by default.
run_on_schedule	bool	False	Enable scheduled pulling.

PullObservationsConfig — pull_observations

Field	Type	Default	Notes
start_datetime	ISO-8601 string	required	First-run window start. Ignored once the watermark advances.
end_datetime	ISO-8601 string	none	Optional window ceiling; sent every run.
subject_group_ids	list[str]	[]	ER subject-group UUIDs (resolved recursively). Empty = no filter.
subwindow_days	int	1	Backfill slice width in days.
force_run_since_start	bool	False	Reset the watermark for one run.
continue_immediately	bool	False	Self-re-trigger the next backfill chunk via PubSub instead of waiting for the next tick.
run_on_schedule	bool	False	Enable scheduled pulling.

run_on_schedule defaults to off

The base PullActionConfiguration defaults run_on_schedule to True, but both pull actions here override it to False — this integration is most often deployed only as a destination, so scheduled pulling is opt-in per connection.

See State & scheduling for watermark, backfill, and scheduling semantics.

ListEventTypesQuery / ListEventTypeFieldsQuery / ListEventFieldValuesQuery — reference actions

Model	Field	Type	Notes
ListEventTypesQuery	—	—	No fields; lists every event type visible to this integration's credentials.
ListEventTypeFieldsQuery	event_type	string	ER event-type slug (e.g. rhino_carcass). Unknown slug → error.
ListEventFieldValuesQuery	event_type	string	Same as above.
ListEventFieldValuesQuery	field_key	string	Field key from that event type's schema. Unknown key → error.

These are stateless config-time lookups, not scheduled actions — see Reference actions for what they return and how the portal uses them.

Environment variables

REGISTER_REFERENCE_ACTIONS

Default: False.

Gates whether list_event_types, list_event_type_fields, and list_event_field_values are included when this runner self-registers with Gundi. They would register with "type": "reference", a type the Gundi API doesn't accept yet — flipping this on before the platform side (PADAS/cdip#461) is merged and deployed would 400 the whole registration call, not just these three actions. Leave it off in every environment until that lands; flip it on afterward to expose the actions (mirrors CMORE's identically-named, identically-gated flag from its own Phase 0 reference-actions work).