Guides
Production Checklist
Essential steps to ensure your Herald integration is robust and secure.
Production Checklist
Before launching your Herald integration to production, review this checklist to ensure stability and cost-efficiency.
1. Environment Configuration
- API Keys: Ensure you are using
hrld_live_...keys for production and keep them in a secure secret manager (e.g., AWS Secrets Manager, Doppler). - Environment Variable: Set
environment: 'production'in the SDK configuration. - RPC Endpoints: Use a dedicated Solana RPC provider (Helius, QuickNode) rather than public endpoints to avoid rate limits during high volume.
2. Notification Strategy
- Idempotency: Use
idempotencyKeyfor everynotifycall to prevent duplicate notifications during network retries. - Categories: Assign correct categories (
defi,governance,marketing) so users can opt-in/out accurately. - Batching: If sending > 5 notifications simultaneously, use the
notify/batchendpoint or the SDK's batching capabilities.
3. Feedback & Monitoring
- Webhooks: Register a production webhook endpoint to receive delivery status updates and bounce notifications.
- Error Handling: Implement logic to handle
INSUFFICIENT_QUOTAandRATE_LIMIT_EXCEEDEDerrors gracefully (e.g., alert your team or retry after a delay). - Analytics: Regularly check
GET /v1/usageto ensure you aren't approaching your monthly messaging limit.
4. User Experience
- Identity Check: Use
client.isRegistered(wallet)to show a "Settings" or "Enable Notifications" button only when appropriate. - Onboarding: Provide a link to the Herald User Portal for users who haven't registered their wallet yet.
- Test Transaction: Send a test notification to your own team's wallet in production to verify the full loop.
Need Help?
- Email: hello@useherald.xyz — general inquiries and support.
- Enterprise partners: contact your dedicated support channel on Slack or Discord.
- Open-source contributors: open a GitHub Issue.
- Dashboard: manage your integration at app.useherald.xyz.