APIs & Events · scenario
Custom API Integration
External Application → REST API → Integration Lab → Webhooks
BasicExample
Overview
- Business problem
- Customers with bespoke portals need a documented, testable contract rather than a bespoke project every time.
- Typical customer
- Enterprises with in-house platforms, integrators and technology partners.
- Integration objective
- Provide a predictable request/response and event contract that any backend can implement in days.
- Systems involved
- Custom application
- Integration Lab REST API
- Webhook receiver
- Integration Lab capabilities used
- Token authentication
- Candidate & assignment resources
- Result reads
- Event delivery
- Expected outcome
- A working integration built against the sandbox before any production credentials are issued.
Workflow
The happy path, step by step.
- 01
Obtain access token
External App
Client credentials exchanged for a scoped bearer token.
- 02
Upsert candidate
External App
External identifier keeps both systems correlated.
- 03
Assign assessment
External App
Entitlement created with an access window.
- 04
Receive events
Webhook receiver
Lifecycle events replace polling.
Negative lifecycle events
How access is revoked, shortened or refused.
Webhook endpoint unavailable
Integration Lab
Delivery retried with exponential backoff; consumer must be idempotent on event id.