API purpose
The SHVYA API surface allows an authorized organization admin to provision keys for supported external lead operations, and separate read-only diagnostic access where applicable.
Getting started
- Sign in as an organization admin and open Connect Hub → SHVYA API.
- Create the appropriately scoped integration key and store it in your server's secret manager.
- Copy the displayed lead API endpoint shown by the current Dashboard, not an assumed undocumented route.
- Send a controlled test request using the displayed contract and one disposable lead.
- Confirm the created/updated lead and inspect validation errors before automation is enabled.
- Revoke keys no longer needed from the same workspace.
API rules
- Organization identity is derived from authenticated credentials, not a customer-supplied organization ID.
- Credentials need the permission to perform the requested operation; diagnostics access does not automatically authorize lead writes.
- Duplicate requests should use supported idempotency or matching behavior to avoid unwanted duplicate leads.
- Validate all pipeline and stage identifiers to belong to the same organization.
If API calls fail
Check the key is still active, required scope/capability, exact URL, request format, valid lead fields, destination permissions and documented rate limits. For 401/403, do not expose keys in the ticket; rotate a suspected compromised key.