Access keys and data sharing
Create scoped access keys, track event notifications and prepare to use map services.
Last updated:
Create an access key
Access keys let authorised applications work with project data through the documented API. A key cannot exceed your account's permissions; project membership and write scope still apply.
- Select Access keys in the user menu at the top right.
- Select Create API key.
- Enter Key name. Consider Write access for an integration that must make changes; every key has read access.
- Set the scope under Projects. If using Selected projects only, select the relevant projects.
- Enter End time if needed and select Create.
- Store the API key secret securely and close it with Saved securely, hide.
The key secret is not shown again. Use Cancel in the list to revoke an unneeded key. Super administrator accounts cannot create access keys. For technical use, see Access keys and v1 API.
Manage event notifications
An organisation administrator can define a webhook to notify another system of data changes, design actions and import events. Agree the receiving system's address and event handling with the team preparing the integration.
- Select Webhooks in the user menu.
- Open Create webhook.
- Set Name, Destination URL, Events and Projects; check Active and select Create.
- Send the generated Signing secret securely to the authorised person configuring the receiver.
- Inspect delivery status and errors in Delivery log. After making the necessary correction, use Resend if needed.
If the signing secret changes, update the receiver too. Queuing a notification does not mean it has been delivered; check delivery status. See the webhook documentation for receiver verification and an implementation example.
Share through map services
WMS provides project layers as map images; OGC API Features provides queries for records and geometry. Access permissions and the relevant module scope apply. Give the OGC services documentation to the team preparing the desktop or web application you will use.