Setup Guide

Set up and configure a HTTP Webhook destination in RudderStack.

5 minute read

This guide will help you set up a HTTP Webhook destination in the RudderStack dashboard. It also lists the configuration settings required to correctly send data from the supported sources to your HTTP Webhook destination.

Connection compatibility

Destination info
Status: Beta Supported sources: Android, iOS , Web, Unity, AMP , Cloud, Warehouse, React Native , Flutter, Cordova, Shopify Refer to it as HTTP in the Integrations object.

Destination info

Status: Beta
Supported sources: Android, iOS , Web, Unity, AMP , Cloud, Warehouse, React Native , Flutter, Cordova, Shopify
Refer to it as HTTP in the Integrations object.

Connection modes
Source	Cloud mode	Device mode	Hybrid mode
AMP
Android
Cloud
Cordova
Flutter
iOS
React Native
Shopify
Unity
Warehouse
Web

Supported message types
Source	Identify	Page	Track	Screen	Group	Alias

Setup

In your RudderStack dashboard, add a source. Then, from the list of destinations, select HTTP Webhook.

Assign a name to uniquely identify your destination in the RudderStack dashboard and click Continue.

Connection settings

Setting Description

API URL

Specify the endpoint where RudderStack sends the events. RudderStack supports both HTTP and HTTPS URLs.

Note that:

For successful event delivery in case of an HTTPS URL, you must have a valid TLS certificate.
To configure the path parameters for this URL, see Request URL settings.

Authentication

Select the authentication method used while configuring your HTTP webhook endpoint. RudderStack supports the below authentication types:

No Auth
Basic Auth
Bearer Token
API Key

Depending on the selected authentication type, configure the below settings:

Auth type	Setting
No Auth	Not applicable
Basic Auth	Username Password
Bearer Token	Token
API Key	Key Value

Method Select the HTTP method of the request sent to the configured endpoint from the dropdown. By default, RudderStack uses the POST method to send the events.

Body Format

Select the body format for your HTTP webhook endpoint. RudderStack supports the following body formats:

JSON
XML
FORM

Event configuration settings

Click Set up mapping to configure the event mappings, query parameters, and headers sent to the HTTP webhook endpoint.

RudderStack uses the in-house JSON template engine for mapping the fields.

Request Body

This setting lets you map the RudderStack event properties to a specific destination field.

Note that the values specified in the Key field must be strictly a JSONPath, whereas the values specified in the Value field can be either a JSONPath or constant. Some examples of valid and invalid values are shown below:

Key	Value	Notes
`$.messageType`	`$.type`	Valid key and value
`$.properties.firstName`	`$traits.fn`	Valid key and value
`properties.value`	`100`	Invalid key, valid value
`$.properties.currency`	`"EUR"`	Valid key, invalid value

XML Root Key setting

If you set the Body Format to XML, then you can specify the root key used as a common prefix for all the field mappings defined in this section.

HTTP request body configuration for XML body format

See the end-to-end example more information on how this setting translates into the final event payload sent to the destination.

Request URL

This setting lets you configure the Path and Query parameters that RudderStack appends to your configured HTTP URL.

Note the following while specifying the path and query parameters:

The values specified as path parameters must be either JSONPath or constants.
For query parameters, the values specified in the Key field must be strictly a constant, whereas the values specified in the Value field can be either a JSONPath or constant.

Some examples of valid and invalid values for these parameters are shown below:

Path parameters

Path	Notes
`$.event.customerId`	Valid path
`order`	Valid path
`"order"`	Invalid path

Query parameters

Key	Value	Notes
`key`	`value`	Valid key and value
`name`	`$traits.firstName`	Valid key and value
`$.messageType`	`100`	Invalid key, valid value
`key`	`"value"`	Valid key, invalid value

Example

Suppose the API URL configured in the RudderStack dashboard is https://example.com/ and you specify the path and query parameters, as follows:

Path parameters in sequence: path, $.userId
Query parameters: key, value

Then, the final generated URL is https://example.com/path/$.userId?key=value.

Headers

This setting lets you add custom headers to your events as per your requirement.

Note that the values specified in the Key field must be strictly a constant, whereas the values specified in the Value field can be either a JSONPath or constant. Some examples of valid and invalid values are shown below:

Key	Value	Notes
`content-type`	`application/json`	Valid key and value
`"content_type"`	`$.content_type`	Invalid key, valid value
`properties.value`	`100`	Invalid key, valid value
`Authorization`	`"event.apiKey"`	Valid key, invalid value

RudderStack also adds the below header for all the requests by default:

Key	Value
`user-agent`	`RudderLabs`

Configuration settings

Configure the below settings to receive your data correctly in your HTTP Webhook destination.

Setting Description

Enable Batching

Setting	Description
Enable Batching	Toggle on this setting to let RudderStack batch the number of requests specified in the Maximum Batch Size setting before sending them to the configured endpoint. Note that: RudderStack supports this feature for the JSON body format only. It sends the batched events in the JSON array format, for example, `[{Event1},{Event2},....{EventN}]`. The maximum batch size must not exceed 100. RudderStack sends the batches to the endpoint when either the batch limit is reached or after 5 seconds (even if batch size is less than the specified limit) - whichever comes first.
Consent management settings	Configure the consent management settings for the specified source by choosing the Consent management provider from the dropdown and entering the relevant consent category IDs. See Consent Management in RudderStack for more information on this feature.

Toggle on this setting to let RudderStack batch the number of requests specified in the Maximum Batch Size setting before sending them to the configured endpoint.

Note that:

RudderStack supports this feature for the JSON body format only. It sends the batched events in the JSON array format, for example, [{Event1},{Event2},....{EventN}].
The maximum batch size must not exceed 100.
RudderStack sends the batches to the endpoint when either the batch limit is reached or after 5 seconds (even if batch size is less than the specified limit) - whichever comes first.

Consent management settings Configure the consent management settings for the specified source by choosing the Consent management provider from the dropdown and entering the relevant consent category IDs. See Consent Management in RudderStack for more information on this feature.

Next steps

Send events to HTTP Webhook destination

FAQ

How do I check for delivery failures while sending events to the HTTP Webhook destination?

Log in to your RudderStack dashboard and go to the Live Events tab of your destination to check for any delivery failures. In case there are any, you can check the Error Response by clicking the event to get more details.

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.

Questions? Contact us by email or on Slack