Notifications

Qrambo sends notifications to keep you informed about changes to Queues, Tasks, and Assignments. This helps you process your workflow by result and track updates without repeatedly checking the API.

How It Works

• We send event notifications to your specified endpoint immediately when they occur
• Notifications are sent using the POST method
• Your endpoint must respond with a 200 status code within 5 seconds
• If a notification fails, we retry 3 times with a 5-second gap between attempts
• We save your response in our database for troubleshooting purposes

Status Types

Configuration Options

• strategy: How to handle multiple notification settings

  • ONLY: Use only the this settings
  • UNION: Combine all applicable settings from this level and parent level

• endpoint: The URL where notifications will be sent

• headers: Additional HTTP headers to include with notifications

• events_to_notify: Specific events you want to receive

Configuration Levels

You can set up notifications at three levels:

1. Organization Level - Applied to all queues in an environment. It is perfect for your data-lake or data-warehouse.
2. Queue Level - Applied to all tasks in a specific queue. It is perfect for your workflow.
3. Task Level - Applied to a single task. It is perfect for your specific needs.

Complex Usage of Notifications

Let’s say you have a queue for image classification operations, and you’ve set up notifications at the queue level. Later, you might want to label some images independently from your real-time operations to maximize your reviewers’ productivity and extra data for AI training. In this case, you can create tasks with lower priority and set up different task-level notifications using the ONLY strategy. This ensures these labeling tasks don’t interfere with your main workflow.

Available Events to be Notified

Best Practices

1. Configure notifications at appropriate levels
2. Use specific event filters
3. Ensure reliable endpoint availability
4. Monitor notification status
5. Handle failed notifications
6. Set up proper error logging