Skip to main content

webhook

Latest Versionv1.0.0
Input Content TypeAny
Output Content TypeAny
Incurs Usage

Sending data to a webhook for transformation incurs usage costs after exceeding the free tier. See Golioth pricing for more information.

The webhook transformer invokes an external API endpoint and, on success, replaces the data message content and content type with that of the response.

Tip

The webhook transformer is not to be confused with the webhook data destination. The transformer allows for modifying the content of a data message in a pipeline via an external API call, while the data destination delivers the event to an external location.

Parameters

ParameterTypeDescriptionRequired
urlstringThe URL for the external webhook.
headersMap (string: string)Headers to be included in requests.

Example Secrets

API_KEY

sup3rs3cr3t

Example Usage

    transformer:
type: webhook
version: v1
parameters:
url: https://my-webhook.example.com
headers:
x-api-key: $API_KEY

Example Input

{
"temp": 32
}

The following headers will be present on all requests to external webhooks, in addition to any defined in the parameters.

  • Ce-Source: ID of device
  • Ce-Subject: ID of project
  • Ce-Type: Prefixed path (if path is /sensor, the value will be io.golioth.data.v1/.s/sensor)
  • Content-Type: the content type of the data message payload

Example Output

In this example, the webhook converts Celsius temperature readings to Fahrenheit.

{
"temp": 89.6
}