REST APIs
Versioned JSON over HTTPS for messaging, verification, contacts, templates, webhooks, usage and account resources.
- Versioned resource paths
- Bearer authentication
- Idempotent write requests
- Structured error responses
Build customer communications and authentication into your products with clear APIs, predictable events and infrastructure designed for serious production workloads.
Use REST APIs for application workflows, SMPP 3.4 for suitable enterprise SMS connectivity, and signed webhooks to keep your systems synchronized with messaging, inbound activity and verification events.
Use REST APIs for application-driven workflows, SMPP 3.4 where sustained SMS throughput and telecom-style connectivity are appropriate, and event-driven webhooks to keep your systems synchronized with delivery, inbound and verification activity.
Versioned JSON over HTTPS for messaging, verification, contacts, templates, webhooks, usage and account resources.
Enterprise SMS connectivity for workloads that benefit from persistent binds, telecom-oriented throughput controls and delivery receipt handling.
Receive asynchronous lifecycle events for delivery, inbound communication, verification, account and workflow activity.
Use environment-scoped credentials and least-privilege access patterns so applications receive only the capabilities they need.
Network failures and timeouts are normal parts of distributed systems. Zayloft integration patterns use idempotency, stable request identifiers and explicit event states so applications can recover without blindly duplicating customer actions.
Attach a unique key to eligible write requests so retries can be recognized instead of creating unintended duplicate operations.
Use stable application and request identifiers to trace work across your system, Zayloft and downstream delivery events.
Treat transport timeouts as unknown outcomes until the request state can be safely resolved.
Reconcile asynchronous delivery and inbound events against your own records using durable identifiers.
The examples below use an environment variable for the API base URL so your deployment can point to the hostname and version configured for your account.
curl "$ZAYLOFT_API_BASE/v1/messages" \
-H "Authorization: Bearer $ZAYLOFT_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: 8f36c1f0-8e7d-4d9d-a342-7aef0c2d45c2" \
-d '{
"channel": "sms",
"to": "+14155550123",
"message": "Your verification code is 482731"
}'
Keep credentials on the server. Never embed API secrets in browser JavaScript, public repositories or mobile application bundles.
Applications should not have to infer message state from a single synchronous response. Delivery, inbound and verification events provide the state changes needed to reconcile customer workflows.
The platform has accepted a valid request for processing.
The message has progressed through the configured delivery path.
A downstream delivery confirmation has been received where the channel provides one.
The operation could not complete and exposes a structured reason suitable for application handling.
A customer-originated message or channel event is available to your application.
A verification workflow has completed successfully according to the configured method.
Start with the integration surface you need, then move into contracts, environments, logs, webhook inspection and usage visibility as your implementation grows.
Machine-readable API definitions support documentation, validation and SDK generation workflows.
Keep development and production credentials, data and application behavior separated.
Trace request IDs, response states and important metadata without exposing secret provider internals to ordinary users.
Inspect delivery attempts, event IDs, signatures and retry history when diagnosing integration behavior.
Track API activity, messaging volume and account consumption using organization and project boundaries.
Use service-health information and application-side resilience patterns to reduce avoidable disruption.
Zayloft developer integrations should keep secrets server-side, verify webhook authenticity, isolate tenants and environments, limit credential scope and record important administrative actions.
Store API keys, SMPP credentials and webhook secrets in protected server-side configuration.
Validate signed payloads before trusting event content or triggering downstream actions.
Issue credentials with only the scopes, projects and environments required by the application.
Keep organization and project data isolated throughout request handling and resource access.
Record key administrative and credential events for operational accountability.
Use modern TLS for public API transport and secure channels for supported persistent protocol connections.
Use predictable requests, scoped credentials, asynchronous events and operational visibility to connect Zayloft with the systems your engineering teams already run.
For API, SMPP, webhook or technical integration enquiries, contact support@zayloft.com.