Platform
Build on Yorlet with APIs, events and hosted frontends
Build custom property workflows with Yorlet's public API resources, webhooks and events, or use hosted frontends for customer-facing journeys.
{
"id": "cus_dfjkf03jf2k0kf",
"name": "John Doe",
"email": "[email protected]",
...
}Public API resources
Use documented Yorlet resources to connect your own systems and property workflows.
Webhooks and events
Subscribe to real-time events and react instantly to changes across your portfolio.
API keys and logs
Authenticate API access with keys and inspect activity in operational logs.
Sandbox and hosted frontends
Test integrations in a sandbox or use Yorlet-hosted customer journeys where they fit.
Connect to Yorlet at the right layer
Work with public API resources and events when you are building a custom integration, or use hosted frontends when you want Yorlet to provide the customer-facing experience.
Public API resources
Use the documented resources exposed by Yorlet to connect your products and operational systems.
Core capabilities
Documented public resources
Authenticated with API keys
API activity logs
Sandbox access
Data imports
Hosted frontends
API Explorer
v1/v1/tenancies/ten_1N4xLk2eZv
Response
200 OK{
"id": "ten_1N4xLk2eZv",
"object": "tenancy",
"status": "active",
"property": "prop_8Qh2bR",
"rent": 1250,
"currency": "gbp",
"interval": "month",
"start_date": "2025-03-01",
"customers": [
"cus_4mKp9Xt..."
]
}Real-time webhooks and events
Subscribe to supported Yorlet events and use webhooks to keep connected systems up to date.
Subscribe to supported event types
Webhook endpoints
Event delivery logs
Inspect delivery outcomes
Webhook events
Import and test safely
Bring data into Yorlet with imports and test your integration against a sandbox before connecting production workflows.
Data imports
Sandbox environment
API and event logs
Hosted frontends for customer journeys
app.js
const Yorlet = require('yorlet'); const yorlet = Yorlet('sk_live_...VxK9'); const tenancy = await yorlet.tenancies.create({ property: 'prop_8Qh2bR', rent: 1250, currency: 'gbp', interval: 'month', }); // ten_1N4xLk2eZv
API keys and operational logs
Manage API access with keys and use logs to inspect integration activity and troubleshoot requests.
Security features
Create API keys
Revoke API keys
Inspect API logs
Inspect event logs
Review request outcomes
Troubleshoot integrations
API keys
| Name | Key | Scope | Created |
|---|---|---|---|
| Production | sk_live_...VxK9 | Full access | Jan 12, 2025 |
| Staging | sk_test_...m3Jp | Full access | Jan 12, 2025 |
| Read-only | sk_live_...hN21 | Read | Mar 4, 2025 |
Everything you need to build on Yorlet
API
Public API resources
API keys
API logs
Sandbox environment
Data imports
Events
Webhook endpoints
Supported event types
Event logs
Delivery outcomes
Delivery logs
Build and test
Sandbox environment
Data imports
API logs
Event logs
Hosted experiences
Hosted frontends
Yorlet-managed customer journeys
Connected to Yorlet records
Use alongside custom integrations
Yorlet Platform questions
- What can I build with the Yorlet Platform?
- You can integrate your systems with Yorlet's public API resources and events, or use Yorlet's hosted frontends when you want Yorlet to provide the customer-facing experience.
- How do I authenticate API requests?
- Yorlet Platform provides API keys for authenticated access to the public API.
- Can I test an integration safely?
- Yes. The sandbox gives you a separate environment for testing before you connect a production workflow.
- Can I inspect integration activity?
- Yes. API and event logs help your team inspect requests and deliveries while building and operating an integration.