Support & Community
Use the resources below to diagnose an integration problem or collect the information needed for a useful support request.
Start here#
- Introduction — Understand the BigState data model and request flow.
- Counter tutorial — Verify an end-to-end HTTP and WebSocket integration.
- API reference — Check endpoint parameters, response shapes, and error codes.
Troubleshooting checklist#
Before reporting an issue, verify the following:
- Base URL — HTTP and WebSocket clients use their respective service URLs.
- Credentials — The request includes a valid API key or token with access to the target resource.
- Resource name — Object and related identifiers use the expected fully qualified format, including the owner where required.
- Request body — JSON requests send
Content-Type: application/json; value uploads send raw bytes instead of JSON. - Delivery configuration — The delivery exists and includes the object whose updates you expect to receive.
- Subscription lifecycle — Register the message handler and delivery IDs before publishing test state.
What to include in a support request#
Provide enough context to reproduce the problem:
- The documentation page and endpoint you are using.
- The SDK name and version, if applicable.
- The HTTP status code or WebSocket notification type.
- The response error
codeandmessage. - A minimal request with credentials and sensitive values removed.
- Expected behavior and actual behavior.
- Whether the problem is consistent or intermittent.
Never include API keys, tokens, private keys, or production data in logs, screenshots, or support requests.