← Back to Sustainability / ESG Tracking overview
API Keys
Module: Sustainability / ESG Tracking
Where to open in admin
- Log in to Admin.
- Open sidebar menu Sustainability / ESG Tracking.
- Click API Keys.
- Direct route (for admins):
admin/esg/esg_api_keys
What this screen is for
Integrate external systems via REST API or outbound webhooks.
How to use — step by step
- Enable API in finance settings.
- Create API key/token and store securely.
- Use Bearer token on requests; add Idempotency-Key on writes.
- Configure webhook URL and verify HMAC signatures on receiver.
Common buttons & actions
- Create key
- Rotate token
- Test webhook
Required permissions
Staff need the esg_api_keys feature with: view, create, delete.
Assign under Setup → Staff → Roles → Permissions. After changing roles, ask the user to log out and log in again.
Before you start
- Make sure your role can view this screen (and create/edit if you will change data).
- Complete module Settings and any required master data first.
- If this screen depends on other CRM data (customers, items, invoices, staff), create those records first.
What good looks like
After you finish on API Keys, you should see the record in the list with the expected status, and any linked stock/finance/message impact should match what you entered. If something looks wrong, open the record again and check required fields, then retry.
Tips & best practices
- Use clear codes/names so teammates can search later.
- Prefer filters (status, date, warehouse, assignee) before exporting large lists.
- Do not delete posted/historical records unless your process allows it — use cancel, reverse, or adjust instead.
- When stuck, compare a working sample record field-by-field with the one that fails.
Troubleshooting this screen
- Blank page / access denied — permission missing or session expired; re-login and check Roles.
- Cannot save — required field empty, invalid date, or master record not selected.
- Numbers look wrong — wrong warehouse/period filter, or related document not posted yet.
- Button missing — your role lacks create/edit/approve/export for this feature.