Best Practices

Based on our comprehensive experience, we recommend the following approach to clients implementing a webhook integration.

Efficient event processing

To improve scalability and manage large volumes of events, decouple acknowledgement and processing.
Store incoming events independently in a database or queue and process them asynchronously at a later time.

Payload support

Make sure that your integration supports all payload types (enums) defined in the API specification for the webhook types you want to use (see API reference).

API specification monitoring

Regularly monitor changes to API specifications to avoid unexpected disruptions.
We recommend that you subscribe to our news via RSS, then you will never miss any releases in the Investment API.
Integrate all relevant changes immediately to maintain seamless operations.

By following these guidelines, you can ensure a smooth and reliable webhook integration with Upvest.

Webhook Endpoint Reliability

Sandbox Environment Cleanup Policy

To maintain optimal performance in our sandbox environment, webhook subscriptions are automatically managed based on endpoint reliability:

Important: If your webhook endpoint consistently fails to receive notifications for 30 consecutive days in the sandbox environment, the subscription will be automatically removed.

What this means for you:

Monitor your sandbox endpoints: Ensure your development/testing webhook endpoints remain accessible
Check your logs regularly: Look for failed webhook delivery attempts in your application logs
Resubscribe if needed: If your subscription is removed, you can easily create a new one through the API
Production is unaffected: This cleanup policy only applies to sandbox environments

Best practices to avoid subscription removal:

Implement proper error handling and return appropriate HTTP status codes (200-299 for success)
Ensure your sandbox webhook endpoints have adequate uptime
Use webhook testing tools during development to verify endpoint functionality
Set up monitoring alerts for your webhook endpoints

This policy helps keep the sandbox environment clean, ensures reliable webhook delivery for active development projects, and allows us to proactively identify potential issues with your webhook integration before they affect your production environment.