Documentation Overview

HybridHero developers

HybridHero
developer portal.

Guidance for developers connecting workplace systems to HybridHero. Request access, plan your integration, and understand authentication, API documentation and support.

Start building Explore the API reference

Your systemsIdentity · calendars · devices</>Integration layerHybridHeroPeople · spaces · bookings

New to HybridHero?Prepare your first integration. Have a use case?Find the right starting point.

Quickstart

From access to your first request

Begin with a read-only operation in an approved test environment. Confirm the endpoint and authentication flow with HybridHero before you connect.

Tell us what you’re building
Identify your organisation, the HybridHero tenant, the systems you want to connect, and the data you need to read or change. Prepare an access request →
Confirm your environment and permissions
Ask for the supported authentication flow, environment URL, permitted operations and test-data requirements for your integration.
Make a read-only request
Use the request example provided for your approved environment. Check the response against its documented schema before adding write operations.
Verify the result
Confirm the response belongs to the intended tenant and location. Record the request ID and UTC time for troubleshooting, without logging credentials or personal data.

Need the exact endpoint?

Environment URLs, credentials and operation details must be confirmed for your integration. See what to request in the API reference.

Access & security

Start with the right permissions

Work with your HybridHero contact to confirm how your integration authenticates and which resources it can access. Employee single sign-on and API credentials serve different purposes.

What to confirm before connecting
Area	Confirm with your team
Identity	The tenant and application or user your integration acts for.
Permissions	Read and write access, resource scope and location restrictions.
Credentials	Approved authentication flow, secure delivery, expiry, rotation and revocation.
Environment	Approved base URL, region and permitted test data.

Keep credentials in server-side secret storage. Never include secrets in browser code, URLs, screenshots or support requests.

Explore HybridHero security ↗

Integration guides

Start with your use case

Use these planning notes to scope the connection. Exact API availability and implementation steps depend on your approved integration.

01Connect people & identity

Define the source of truth for people, the stable identifier used to match accounts, and which teams and locations are included.

Confirm whether you need employee SSO, directory provisioning, or API access.
Agree joiner, mover and leaver behaviour before synchronising accounts.
Verify account matching with approved test users.

Explore identity integrations ↗

02Connect bookings & spaces

Specify the resource type, locations, calendar system and booking actions your workflow needs.

Confirm availability, booking windows, timezones and approval rules.
Define conflict handling and who owns updates or cancellations.
Verify the final booking state in HybridHero before expanding the rollout.

Discuss a booking integration →

03Connect check-ins & devices

Describe your scanner, panel or kiosk and how it identifies the user and location.

Confirm the supported hardware and external check-in workflow.
Agree eligibility rules, repeated attempts and offline behaviour.
Use stable identifiers; do not match a person by display name alone.

Discuss a device integration →

04Connect workplace reporting

Define the reporting outcome and minimum data needed. Confirm an export or integration route for the relevant modules.

Agree the data fields, refresh frequency and location scope.
Confirm access controls, storage region and retention requirements.
Validate totals and timezone handling before relying on reports.

Discuss reporting requirements →

API reference

Know the contract before you code

Request the approved API definition for your integration. This overview does not publish an endpoint catalogue; paths, payloads and authentication examples need to match the supported API.

Resources & operations

Supported resources, methods, paths, required fields and response schemas.

Behaviour & reliability

Pagination, filtering, rate limits, retries, idempotency and error handling.

Version & lifecycle

Applicable version, availability, change notices and migration requirements.

Request API documentation →

Event-driven integrations

Plan for reliable event handling

If your use case needs event notifications, first confirm that external webhooks are supported for the required workflow. Ask for the event catalogue and delivery contract before building a consumer.

Supported events and subscription setup
Signature verification and secret rotation
Timeouts, retries, duplicate delivery and ordering
Test delivery, replay and failure recovery

Webhook availability and event names are not confirmed by this overview.

Developer support

Keep troubleshooting focused

Start with the environment, identity and permissions. Use the error definitions in your approved API documentation to decide whether to correct a request or retry it.

My request is rejected

Check the environment URL, authentication flow, credential expiry and tenant permissions. Compare required fields with the operation schema. Do not retry an unchanged request indefinitely.

The result does not match what I expected

Check the tenant, location, stable identifiers, filters, pagination and timezone. Compare with the expected product state using approved test data.

I need to escalate an issue

Provide the diagnostic details below through your agreed support route. Remove credentials and personal data. Ask your HybridHero contact which support channel applies to your integration.

Support request checklist

Environment and region:
Operation or endpoint:
UTC timestamp:
Response code:
Request ID (if available):
Expected behaviour:
Observed behaviour:
Exclude tokens, secrets and personal data.

Visit the Help Center ↗

Your next step

Let’s scope your integration.

Tell us what you want to connect. The team can help confirm the right access route and technical requirements.

Your organisation and HybridHero tenant
The systems, modules and actions involved
Environment, region and expected volume
Your technical contact and intended rollout

Contact the team

Use the contact form to describe your developer access request. Do not include credentials or personal data.

HybridHero developer portalBack to top ↑