Webhooks (Actions) Destination
Additional versions of this destination are available
This page is about the Webhooks (Actions) Destination. See below for information about other versions of the Webhooks destination:
Segment’s Webhooks (Actions) destination uses internet protocol and HTTP callback to submit real-time user data to your own HTTP endpoints. With this destination, you can POST, PUT, or PATCH data to any webhook URL.
Getting Started
- From the Segment web app, navigate to Connections > Catalog.
- Search for Webhooks (Actions) in the Destinations Catalog, and select the destination.
- Click Configure Webhooks (Actions).
- Select the source that will send data to Webhooks (Actions) and follow the steps to name your destination.
- If you require authentication, add in a shared secret on the Settings > Advanced Settings tab. If you provide a shared secret, Segment will sign requests with an HMAC in the “X-Signature” request header. The HMAC is a hex-encoded SHA1 hash generated using the shared secret and the request body.
- Follow the steps in the Destinations Actions documentation on Customizing mappings. You can create up to 5 mappings, each of which can send to a different webhook URL.
- Enable the destination and configured mappings.
Destination Settings
Setting | Description |
---|---|
Shared Secret | If set, Segment will sign requests with an HMAC in the “X-Signature” request header. The HMAC is a hex-encoded SHA1 hash generated using this shared secret and the request body. |
Available Actions
Build your own Mappings. Combine supported triggers with the following Webhooks-supported actions:
Mapping limits per destination
Individual destination instances have support a maximum of 50 mappings.
Send
Send an HTTP request.
Send is a Cloud action.
Field | Description |
---|---|
URL* | Type: STRING URL to deliver data to. |
Method* | Type: STRING HTTP method to use. |
Batch Size | Type: NUMBER Maximum number of events to include in each batch. Actual batch sizes may be lower. |
Headers | Type: OBJECT HTTP headers to send with each request. |
Data | Type: OBJECT Payload to deliver to webhook URL (JSON-encoded). |
Enable Batching? | Type: BOOLEAN When enabled, Segment will send events in batches. |
Batch size limits
In Webhook Actions mapping, the default value of batch size is 1000
. You can change this value, but there’s a maximum batch size limit of 4000
.
FAQs
Why is a Webhooks (Actions) Destination helpful with end-to-end tests?
The easiest way to test whether a source’s events are sending through the Segment pipeline is with an end-to-end test. Use the steps below to monitor the events arriving to your Segment source and whether they’re successfully sending to your destinations. Connecting a Webhooks (Actions) Destination to your sources makes these requests easy to see. For example, if you connect a Webhooks Destination (Webhook Actions Destination) to your source, you’d be able to see the events received by that source and sent to that destination.
Connect a Webhook Actions destination to your workspace
- Add a new Webhook (Actions) destination to your source. Make sure you select the intended source to connect this destination to.
- Visit the webhook’s site, and copy the endpoint to your clipboard. An example site you can use is https://webhook.site/#!/, but use whichever webhooks site you prefer.
- Add a mapping to the Webhook Actions destination, and configure Step 1’s conditions to allow for all types of events that you’re currently sending through that source.
- Add the endpoint you copied from Step 2 to the Webhook Actions Mapping’s URL in Step 3.
- Enable the Mapping.
- Enable the Webhook Actions destination.
- Begin sending events to your source.
- Verify those events throughout the Segment pipeline (source debugger/ event delivery).
- Verify the webhook’s website which shows the raw JSON for all of the events successfully received by your Segment source and its Webhooks Actions destination.
This page was last modified: 29 May 2024
Need support?
Questions? Problems? Need more info? Contact Segment Support for assistance!