Conventions
- Base URL is
https://api.shubham.ai/v1. The version is in the path. - All requests and responses are JSON. Send
Content-Type: application/json. - Authentication is a bearer token:
Authorization: Bearer sk_live_…. - Money is always in minor units as an integer — paise, cents. There are no floats anywhere in the API, because a rounding error on an invoice is not a rounding error to the customer.
- Timestamps are ISO 8601 in UTC.
- Every response carries
X-Request-Id. Quote it when contacting support.
Errors
Errors use a consistent shape with a stable machine-readable code.
{
"error": {
"code": "permission_denied",
"message": "This key does not hold campaign.send.",
"requestId": "req_01J8ZK4M2Q",
"docs": "https://shubham.ai/docs/api#errors"
}
}
GET /v1/contacts?limit=50&cursor=eyJpZCI6ImNudF80ODIwIn0
{
"data": [ /* … */ ],
"pagination": {
"hasMore": true,
"nextCursor": "eyJpZCI6ImNudF80OTAxIn0",
"total": 41208
}
}
Rate limits
Defaults are 600 reads and 120 writes per minute per key, and you can set a lower ceiling per key. Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. A 429 always includes Retry-After in seconds — honour it rather than retrying immediately.
Endpoints
Grouped by the plugin that publishes them. An endpoint only exists for a tenant that has the owning plugin enabled — calling one you do not hold returns permission_denied, not not_found.
Webhook events
Subscribe to any of these under Settings → Developers → Webhooks. Every delivery is signed; verify the signature before trusting the body.
Billing & Subscriptions
invoice.issuedwallet.creditedwallet.debitedsubscription.changed
WhatsApp Cloud API
channel.connectedchannel.disconnectedchannel.health_changedmessage.deliveredmessage.failed
Embedded Signup
channel.connected
QR Session (Unofficial)
channel.connectedchannel.disconnected
Shared Team Inbox
conversation.startedconversation.assignedconversation.resolved
Broadcast & Campaigns
campaign.scheduledcampaign.sent
Templates
template.status_changed
Forms & Lead Capture
lead.created
Flow Builder
workflow.startedworkflow.completedworkflow.failed
Automation Rules
automation.triggered
AI Agents
ai.response_generatedai.tool_invoked
Contacts
contact.createdcontact.imported
Leads & Pipeline
lead.createdlead.stage_changeddeal.wondeal.lost
Payments
payment.completedpayment.failed
Tenant Management
tenant.createdtenant.suspendedtenant.reactivatedtenant.impersonation_startedtenant.impersonation_ended
Plugin Marketplace
plugin.installedplugin.enabledplugin.disabledplugin.upgraded
Plans & Pricing
subscription.changed
Credits & Wallet Ops
wallet.creditedwallet.debited
This reference is generated from the plugin registry, which is why it cannot document an endpoint the product does not publish. If something is missing here, it does not exist yet.