> For the complete documentation index, see [llms.txt](https://docs.roboflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roboflow.com/workflows/blocks/blocks/data-storage/webhook-sink.md). # Webhook Sink The **Webhook Sink** block enables sending a data from Workflow into external APIs by sending HTTP requests containing workflow results. ## How This Block Works 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=` ### 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. {% hint style="warning" %} **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. {% endhint %} ### 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. ## Common Use Cases * Use this block to \[purpose based on block type] ## Connecting to Other Blocks The outputs from this block can be connected to other blocks in your workflow. ### Type identifier Use the following identifier in step `"type"` field: `roboflow_core/webhook_sink@v1` to add the block as a 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. ### Runtime compatibility `requires_internet` - air-gapped / offline deployments : This block depends on a service that is not reachable from fully offline / air-gapped deployments. `soft` - runtime `hosted_serverless`, `dedicated_deployment`; execution `remote` : Cooldown / rate-limit timer is stored in process memory. With remote step execution on stateless or multi-replica HTTP runtimes each request gets a fresh worker, so cooldown does not throttle. Cooldown only behaves as documented with local step execution in a persistent WebRTC session. ### Input and Output Bindings The available connections depend on its binding kinds. Check what binding kinds `Webhook Sink` in version `v1` has.
Input and output bindings * input * `url` ([*`string`*](/workflows/developer-guide/developer-guide/kinds/string.md)): URL of the resource to make request. * `query_parameters` (*Union\[*[*`roboflow_model_id`*](/workflows/developer-guide/developer-guide/kinds/roboflow-model-id.md)*,* [*`list_of_values`*](/workflows/developer-guide/developer-guide/kinds/list-of-values.md)*,* [*`integer`*](/workflows/developer-guide/developer-guide/kinds/integer.md)*,* [*`string`*](/workflows/developer-guide/developer-guide/kinds/string.md)*,* [*`float`*](/workflows/developer-guide/developer-guide/kinds/float.md)*,* [*`boolean`*](/workflows/developer-guide/developer-guide/kinds/boolean.md)*,* [*`roboflow_api_key`*](/workflows/developer-guide/developer-guide/kinds/roboflow-api-key.md)*,* [*`top_class`*](/workflows/developer-guide/developer-guide/kinds/top-class.md)*,* [*`roboflow_project`*](/workflows/developer-guide/developer-guide/kinds/roboflow-project.md)*,* [*`float_zero_to_one`*](/workflows/developer-guide/developer-guide/kinds/float-zero-to-one.md)*]*): Request query parameters. * `headers` (*Union\[*[*`roboflow_model_id`*](/workflows/developer-guide/developer-guide/kinds/roboflow-model-id.md)*,* [*`integer`*](/workflows/developer-guide/developer-guide/kinds/integer.md)*,* [*`float_zero_to_one`*](/workflows/developer-guide/developer-guide/kinds/float-zero-to-one.md)*,* [*`string`*](/workflows/developer-guide/developer-guide/kinds/string.md)*,* [*`float`*](/workflows/developer-guide/developer-guide/kinds/float.md)*,* [*`roboflow_api_key`*](/workflows/developer-guide/developer-guide/kinds/roboflow-api-key.md)*,* [*`top_class`*](/workflows/developer-guide/developer-guide/kinds/top-class.md)*,* [*`roboflow_project`*](/workflows/developer-guide/developer-guide/kinds/roboflow-project.md)*,* [*`boolean`*](/workflows/developer-guide/developer-guide/kinds/boolean.md)*]*): Request headers. * `json_payload` ([*`*`*](/workflows/developer-guide/developer-guide/kinds/wildcard.md)): Fields to put into JSON payload. * `multi_part_encoded_files` ([*`*`*](/workflows/developer-guide/developer-guide/kinds/wildcard.md)): Data to POST as Multipart-Encoded File. * `form_data` ([*`*`*](/workflows/developer-guide/developer-guide/kinds/wildcard.md)): Fields to put into form-data. * `request_timeout` ([*`integer`*](/workflows/developer-guide/developer-guide/kinds/integer.md)): Number of seconds to wait for remote API response. * `fire_and_forget` ([*`boolean`*](/workflows/developer-guide/developer-guide/kinds/boolean.md)): Boolean flag to run the block asynchronously (True) for faster workflows or synchronously (False) for debugging and error handling.. * `disable_sink` ([*`boolean`*](/workflows/developer-guide/developer-guide/kinds/boolean.md)): Boolean flag to disable block execution.. * `cooldown_seconds` ([*`integer`*](/workflows/developer-guide/developer-guide/kinds/integer.md)): Number of seconds to wait until follow-up notification can be sent.. * output * `error_status` ([`boolean`](/workflows/developer-guide/developer-guide/kinds/boolean.md)): Boolean flag. * `throttling_status` ([`boolean`](/workflows/developer-guide/developer-guide/kinds/boolean.md)): Boolean flag. * `message` ([`string`](/workflows/developer-guide/developer-guide/kinds/string.md)): String value.
Example JSON definition ```json { "name": "", "type": "roboflow_core/webhook_sink@v1", "url": "", "method": "", "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" } ```