Webhook Sink¶
Class: WebhookSinkBlockV1
Source: inference.core.workflows.core_steps.sinks.webhook.v1.WebhookSinkBlockV1
The Webhook Sink block enables sending a data from Workflow into external APIs by sending HTTP requests containing workflow results. It supports multiple HTTP methods (GET, POST, PUT) and can be configured to send:
-
JSON payloads
-
query parameters
-
multipart-encoded files
This block is designed to provide flexibility for integrating workflows with remote systems for data exchange, notifications, or other integrations.
Setting Query Parameters¶
You can easily set query parameters for your request:
query_parameters = {
"api_key": "$inputs.api_key",
}
will send request into the following URL: https://your-host/some/resource?api_key=<API_KEY_VALUE>
Setting headers¶
Setting headers is as easy as setting query parameters:
headers = {
"api_key": "$inputs.api_key",
}
Sending JSON payloads¶
You can set the body of your message to be JSON document that you construct specifying json_payload
and json_payload_operations properties. json_payload works similarly to query_parameters and
headers, but you can optionally apply UQL operations on top of JSON body elements.
Let's assume that you want to send number of bounding boxes predicted by object detection model
in body field named detections_number, then you need to specify configuration similar to the
following:
json_payload = {
"detections_number": "$steps.model.predictions",
}
json_payload_operations = {
"detections_number": [{"type": "SequenceLength"}]
}
Multipart-Encoded Files in POST requests¶
Your endpoint may also accept multipart requests. You can form them in a way which is similar to
JSON payloads - setting multi_part_encoded_files and multi_part_encoded_files_operations.
Let's assume you want to send the image in the request, then your configuration may be the following:
multi_part_encoded_files = {
"image": "$inputs.image",
}
multi_part_encoded_files_operations = {
"image": [{"type": "ConvertImageToJPEG"}]
}
Cooldown¶
The block accepts cooldown_seconds (which defaults to 5 seconds) to prevent unintended bursts of
notifications. Please adjust it according to your needs, setting 0 indicate no cooldown.
During cooldown period, consecutive runs of the step will cause throttling_status output to be set True
and no notification will be sent.
Cooldown limitations
Current implementation of cooldown is limited to video processing - using this block in context of a
Workflow that is run behind HTTP service (Roboflow Hosted API, Dedicated Deployment or self-hosted
inference server) will have no effect for processing HTTP requests.
Async execution¶
Configure the fire_and_forget property. Set it to True if you want the request to be sent in the background,
allowing the Workflow to proceed without waiting on data to be sent. In this case you will not be able to rely on
error_status output which will always be set to False, so we recommend setting the fire_and_forget=False for
debugging purposes.
Disabling notifications based on runtime parameter¶
Sometimes it would be convenient to manually disable the Webhook sink block. This is possible
setting disable_sink flag to hold reference to Workflow input. with such setup, caller would be
able to disable the sink when needed sending agreed input parameter.
Type identifier¶
Use the following identifier in step "type" field: roboflow_core/webhook_sink@v1to add the block as
as step in your workflow.
Properties¶
| Name | Type | Description | Refs |
|---|---|---|---|
name |
str |
Enter a unique identifier for this step.. | ❌ |
url |
str |
URL of the resource to make request. | ✅ |
method |
str |
HTTP method to be used. | ❌ |
query_parameters |
Dict[str, Union[List[Union[bool, float, int, str]], bool, float, int, str]] |
Request query parameters. | ✅ |
headers |
Dict[str, Union[bool, float, int, str]] |
Request headers. | ✅ |
json_payload |
Dict[str, Union[Dict[Any, Any], List[Any], bool, float, int, str]] |
Fields to put into JSON payload. | ✅ |
json_payload_operations |
Dict[str, List[Union[ClassificationPropertyExtract, ConvertDictionaryToJSON, ConvertImageToBase64, ConvertImageToJPEG, DetectionsFilter, DetectionsOffset, DetectionsPropertyExtract, DetectionsRename, DetectionsSelection, DetectionsShift, DetectionsToDictionary, Divide, ExtractDetectionProperty, ExtractFrameMetadata, ExtractImageProperty, LookupTable, Multiply, NumberRound, NumericSequenceAggregate, PickDetectionsByParentClass, RandomNumber, SequenceAggregate, SequenceApply, SequenceElementsCount, SequenceLength, SequenceMap, SortDetections, StringMatches, StringSubSequence, StringToLowerCase, StringToUpperCase, TimestampToISOFormat, ToBoolean, ToNumber, ToString]]] |
UQL definitions of operations to be performed on defined data w.r.t. each value of json_payload parameter. |
❌ |
multi_part_encoded_files |
Dict[str, Union[Dict[Any, Any], List[Any], bool, float, int, str]] |
Data to POST as Multipart-Encoded File. | ✅ |
multi_part_encoded_files_operations |
Dict[str, List[Union[ClassificationPropertyExtract, ConvertDictionaryToJSON, ConvertImageToBase64, ConvertImageToJPEG, DetectionsFilter, DetectionsOffset, DetectionsPropertyExtract, DetectionsRename, DetectionsSelection, DetectionsShift, DetectionsToDictionary, Divide, ExtractDetectionProperty, ExtractFrameMetadata, ExtractImageProperty, LookupTable, Multiply, NumberRound, NumericSequenceAggregate, PickDetectionsByParentClass, RandomNumber, SequenceAggregate, SequenceApply, SequenceElementsCount, SequenceLength, SequenceMap, SortDetections, StringMatches, StringSubSequence, StringToLowerCase, StringToUpperCase, TimestampToISOFormat, ToBoolean, ToNumber, ToString]]] |
UQL definitions of operations to be performed on defined data w.r.t. each value of multi_part_encoded_files parameter. |
❌ |
form_data |
Dict[str, Union[Dict[Any, Any], List[Any], bool, float, int, str]] |
Fields to put into form-data. | ✅ |
form_data_operations |
Dict[str, List[Union[ClassificationPropertyExtract, ConvertDictionaryToJSON, ConvertImageToBase64, ConvertImageToJPEG, DetectionsFilter, DetectionsOffset, DetectionsPropertyExtract, DetectionsRename, DetectionsSelection, DetectionsShift, DetectionsToDictionary, Divide, ExtractDetectionProperty, ExtractFrameMetadata, ExtractImageProperty, LookupTable, Multiply, NumberRound, NumericSequenceAggregate, PickDetectionsByParentClass, RandomNumber, SequenceAggregate, SequenceApply, SequenceElementsCount, SequenceLength, SequenceMap, SortDetections, StringMatches, StringSubSequence, StringToLowerCase, StringToUpperCase, TimestampToISOFormat, ToBoolean, ToNumber, ToString]]] |
UQL definitions of operations to be performed on defined data w.r.t. each value of form_data parameter. |
❌ |
request_timeout |
int |
Number of seconds to wait for remote API response. | ✅ |
fire_and_forget |
bool |
Boolean flag to run the block asynchronously (True) for faster workflows or synchronously (False) for debugging and error handling.. | ✅ |
disable_sink |
bool |
Boolean flag to disable block execution.. | ✅ |
cooldown_seconds |
int |
Number of seconds to wait until follow-up notification can be sent.. | ✅ |
The Refs column marks possibility to parametrise the property with dynamic values available
in workflow runtime. See Bindings for more info.
Available Connections¶
Compatible Blocks
Check what blocks you can connect to Webhook Sink in version v1.
- inputs:
Size Measurement,CogVLM,Image Slicer,Clip Comparison,Webhook Sink,Pixelate Visualization,Image Threshold,SmolVLM2,Twilio SMS Notification,Image Slicer,Moondream2,Image Blur,Detections Consensus,Morphological Transformation,Polygon Visualization,Single-Label Classification Model,Florence-2 Model,Time in Zone,Single-Label Classification Model,Background Color Visualization,VLM as Detector,Stability AI Image Generation,Overlap Filter,Line Counter,Cache Set,Environment Secrets Store,Detections Merge,Detections Classes Replacement,Trace Visualization,Qwen2.5-VL,LMM,Detections Stitch,Instance Segmentation Model,Ellipse Visualization,Velocity,Reference Path Visualization,Object Detection Model,First Non Empty Or Default,Time in Zone,Anthropic Claude,Template Matching,Image Preprocessing,Triangle Visualization,Keypoint Detection Model,SIFT,Depth Estimation,Email Notification,Gaze Detection,Property Definition,VLM as Detector,Crop Visualization,Image Contours,Segment Anything 2 Model,Contrast Equalization,Instance Segmentation Model,Google Vision OCR,Time in Zone,OpenAI,SIFT Comparison,Detections Combine,Barcode Detection,Roboflow Dataset Upload,Classification Label Visualization,CLIP Embedding Model,OpenAI,Keypoint Visualization,Perspective Correction,Pixel Color Count,Bounding Rectangle,Polygon Zone Visualization,Llama 3.2 Vision,Dynamic Zone,Image Convert Grayscale,Detections Stabilizer,Circle Visualization,Icon Visualization,Stability AI Inpainting,Detections Transformation,Path Deviation,Dominant Color,Rate Limiter,EasyOCR,Google Gemini,Relative Static Crop,Buffer,Expression,Stability AI Outpainting,VLM as Classifier,SIFT Comparison,Blur Visualization,Cache Get,VLM as Classifier,Byte Tracker,Camera Calibration,Delta Filter,OpenAI,Dot Visualization,Identify Changes,PTZ Tracking (ONVIF).md),Distance Measurement,Multi-Label Classification Model,Roboflow Dataset Upload,Corner Visualization,Halo Visualization,CSV Formatter,Mask Visualization,OCR Model,Model Monitoring Inference Aggregator,Camera Focus,Color Visualization,Clip Comparison,Identify Outliers,Continue If,Cosine Similarity,Model Comparison Visualization,Roboflow Custom Metadata,Data Aggregator,Detections Filter,Dynamic Crop,Line Counter Visualization,Multi-Label Classification Model,Dimension Collapse,Perception Encoder Embedding Model,Grid Visualization,QR Code Detection,Stitch Images,Byte Tracker,Absolute Static Crop,Path Deviation,Keypoint Detection Model,Stitch OCR Detections,YOLO-World Model,QR Code Generator,Local File Sink,Slack Notification,Object Detection Model,Florence-2 Model,Bounding Box Visualization,LMM For Classification,Detection Offset,JSON Parser,Label Visualization,Byte Tracker,Line Counter - outputs:
Stability AI Outpainting,Size Measurement,CogVLM,Pixelate Visualization,Webhook Sink,Image Threshold,Blur Visualization,Cache Get,Twilio SMS Notification,Moondream2,Image Blur,Detections Consensus,Morphological Transformation,OpenAI,Polygon Visualization,Single-Label Classification Model,Dot Visualization,Florence-2 Model,Time in Zone,Single-Label Classification Model,PTZ Tracking (ONVIF).md),Background Color Visualization,Distance Measurement,Stability AI Image Generation,Multi-Label Classification Model,Roboflow Dataset Upload,Corner Visualization,Line Counter,Cache Set,Halo Visualization,Mask Visualization,Detections Classes Replacement,Trace Visualization,Model Monitoring Inference Aggregator,Color Visualization,Clip Comparison,LMM,Detections Stitch,Ellipse Visualization,Instance Segmentation Model,Model Comparison Visualization,Object Detection Model,Time in Zone,Triangle Visualization,Template Matching,Image Preprocessing,Anthropic Claude,Roboflow Custom Metadata,Keypoint Detection Model,Email Notification,Gaze Detection,Line Counter Visualization,Dynamic Crop,Crop Visualization,Multi-Label Classification Model,Segment Anything 2 Model,Contrast Equalization,Perception Encoder Embedding Model,Instance Segmentation Model,Google Vision OCR,Time in Zone,OpenAI,SIFT Comparison,Classification Label Visualization,Roboflow Dataset Upload,CLIP Embedding Model,Keypoint Visualization,OpenAI,Perspective Correction,Pixel Color Count,Path Deviation,Polygon Zone Visualization,Keypoint Detection Model,Dynamic Zone,Llama 3.2 Vision,Stitch OCR Detections,YOLO-World Model,QR Code Generator,Local File Sink,Slack Notification,Circle Visualization,Icon Visualization,Object Detection Model,Stability AI Inpainting,Florence-2 Model,Bounding Box Visualization,LMM For Classification,Path Deviation,Label Visualization,Reference Path Visualization,Google Gemini,Line Counter
Input and Output Bindings¶
The available connections depend on its binding kinds. Check what binding kinds
Webhook Sink in version v1 has.
Bindings
-
input
url(string): URL of the resource to make request.query_parameters(Union[list_of_values,roboflow_api_key,top_class,boolean,roboflow_project,integer,float_zero_to_one,roboflow_model_id,float,string]): Request query parameters.headers(Union[roboflow_api_key,top_class,boolean,roboflow_project,integer,float_zero_to_one,roboflow_model_id,float,string]): Request headers.json_payload(*): Fields to put into JSON payload.multi_part_encoded_files(*): Data to POST as Multipart-Encoded File.form_data(*): Fields to put into form-data.request_timeout(integer): Number of seconds to wait for remote API response.fire_and_forget(boolean): Boolean flag to run the block asynchronously (True) for faster workflows or synchronously (False) for debugging and error handling..disable_sink(boolean): Boolean flag to disable block execution..cooldown_seconds(integer): Number of seconds to wait until follow-up notification can be sent..
-
output
Example JSON definition of step Webhook Sink in version v1
{
"name": "<your_step_name_here>",
"type": "roboflow_core/webhook_sink@v1",
"url": "<block_does_not_provide_example>",
"method": "<block_does_not_provide_example>",
"query_parameters": {
"api_key": "$inputs.api_key"
},
"headers": {
"api_key": "$inputs.api_key"
},
"json_payload": {
"field": "$steps.model.predictions"
},
"json_payload_operations": {
"predictions": [
{
"property_name": "class_name",
"type": "DetectionsPropertyExtract"
}
]
},
"multi_part_encoded_files": {
"image": "$steps.visualization.image"
},
"multi_part_encoded_files_operations": {
"predictions": [
{
"property_name": "class_name",
"type": "DetectionsPropertyExtract"
}
]
},
"form_data": {
"field": "$inputs.field_value"
},
"form_data_operations": {
"predictions": [
{
"property_name": "class_name",
"type": "DetectionsPropertyExtract"
}
]
},
"request_timeout": "$inputs.request_timeout",
"fire_and_forget": "$inputs.fire_and_forget",
"disable_sink": false,
"cooldown_seconds": "$inputs.cooldown_seconds"
}