Overview

Receive HTTP Webhook node inserts metadata from received HTTP requests into frame metadata.

Inputs & Outputs

Inputs : 1, Media Format : Any
Outputs : 1, Media Format: Same as Input
Output Metadata : See below.

Properties

Property	Description	Type	Default	Required
`path_key`	Configure your webhook to be sent to `http://<gateway_ip>:3003/v1/webhooks/<path_key>`. Path key part of the webhook URL. Supported metadata sources are URL query parameters in GET requests and JSON bodies in POST.	`string`	`null`	Yes

Path Key configuration

This key will determine the URL to which HTTP requests can be sent. This node listens on the following URL for your HTTP requests:
http://<gateway_ip>:3003/v1/webhooks/<path_key>
e.g. if your gateway's IP address is 192.168.1.123 and path_key is webhook-test, the URL is http://192.168.1.123:3003/v1/webhooks/webhook-test.

Notes:

Authentication is currently not required.
path_key should not contain slashes.
Send GET requests with URL query parameters, e.g. ?door_open=1&additional_arg=value to insert parameters in downstream metadata
Send POST requests to insert metadata from JSON bodies, e.g. { "door_open": 1, "additional_arg": "value" }. Note that URL query parameters are ignored in POST requests.

Output Metadata

The fields below are declared by this node's metadata schema; the JSON values are representative examples.

Path	Type	Description
`nodes.<node_id>.meta_present`	`boolean`	When webhook metadata is present
`<node_id>.meta`	`json`	Metadata received via the HTTP request. For POST requests, JSON body is inserted as is, while for GET requests, URL query parameters are converted into a JSON dictionary.
`nodes.<node_id>.type`	`string`	Identifies the node type that produced this metadata.
`nodes.<node_id>.timestamp`	`string`	Additional timestamp indicating when the request was received, in ISO 3339 format. Present only if `meta_present` is true.

JSON example

{
  "nodes": {
    "webhook_receiver1": {
      "meta": {
        "door_open": 1,
        "additional_arg": "value",
        "example_prop": {
          "test": 1          
        }
      },
      "meta_present": true,
      "type": "webhook_receiver",
      "timestamp": "2023-11-15T14:25:26.011620590+00:00"
    }
  }
}