Skip to main content
Data Security and Reliability

Integration, API, and Change Security

Secure API key, integration, and webhook management, plus Hanna's change controls.

Last updated 13 days ago

Integrations extend Hanna, but their security depends on appropriate permissions, secret management, and controlled changes.

API connection security

The Hanna REST API exchanges JSON data over encrypted HTTPS connections. Authentication and access control are enforced at the API layer, so an integration can perform only authorised actions.

When building an integration:

  1. Create a dedicated API key and grant only the permissions it needs.
  2. Store the key in a secrets manager or secure environment configuration, not in source code or documents.
  3. Limit who can view, replace, or revoke the key.
  4. Log integration errors and unusual request volumes without logging secrets.
  5. Review keys regularly and revoke those no longer used.

Apply the third-party provider's security requirements as well. Hanna cannot control how data is protected after it has been legitimately sent to an integration selected by your organisation.

Webhooks and incoming data

Treat a webhook destination as sensitive configuration. The receiving system should validate incoming data, limit its processing, and log errors safely. After changing an endpoint or credentials, test the complete flow from the Hanna event to the destination system.

Hanna change management

Hanna uses a documented change management process. Code review, quality checks, and testing are completed before deployment. Releases are staged, and security updates and patches are applied automatically. Customers are notified in advance of material changes when applicable.

If an integration does not work as expected

  1. Confirm the organisation address, API version, and documentation.
  2. Check the key status and permissions without copying its value into a support request.
  3. Record the request time, method, path, response code, and safely redacted error text.
  4. Check the Hanna status page for an incident.
  5. If the issue remains, contact Hanna Customer Support. Provide a key name or identifier, never the key value, passwords, or other secrets.

Was this helpful?

Still need help? Ask the team