Skip to content

Commit 35c64ea

Browse files
authored
Adding FAQs
this is a redo of this item: #5101 as it won't pass Snyk.
1 parent 3f8e9f2 commit 35c64ea

File tree

1 file changed

+44
-0
lines changed
  • src/connections/destinations/catalog/actions-webhook

1 file changed

+44
-0
lines changed

src/connections/destinations/catalog/actions-webhook/index.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,47 @@ Segment's Webhooks (Actions) destination uses internet protocol and HTTP callbac
2727
## Batch size limits
2828

2929
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`.
30+
31+
---
32+
title: Webhooks (Actions) Destination
33+
hide-boilerplate: true
34+
hide-dossier: false
35+
id: 614a3c7d791c91c41bae7599
36+
versions:
37+
- name: 'Webhooks (Classic)'
38+
link: '/docs/connections/destinations/catalog/webhooks'
39+
---
40+
41+
{% include content/plan-grid.md name="actions" %}
42+
43+
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.
44+
45+
## Getting Started
46+
47+
1. From the Segment web app, navigate to **Connections > Catalog**.
48+
2. Search for **Webhooks (Actions)** in the Destinations Catalog, and select the destination.
49+
3. Click **Configure Webhooks (Actions)**.
50+
4. Select the source that will send data to Webhooks (Actions) and follow the steps to name your destination.
51+
5. 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.
52+
6. Follow the steps in the Destinations Actions documentation on [Customizing mappings](/docs/connections/destinations/actions/#customize-mappings). You can create up to 5 mappings, each of which can send to a different webhook URL.
53+
7. Enable the destination and configured mappings.
54+
55+
{% include components/actions-fields.html settings="true"%}
56+
57+
## Batch size limits
58+
59+
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`.
60+
61+
## FAQs
62+
63+
### Why is a Webhooks (Actions) Destination helpful with end-to-end tests?
64+
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.
65+
66+
#### Connect a Webhook Actions destination to your workspace
67+
1. [Add a new Webhook (Actions) destination](https://app.segment.com/goto-my-workspace/destinations/catalog/actions-webhook) to your source. Make sure you select the intended source to connect this destination to.
68+
2. Visit the Webhook's site, and copy the endpoint to your clipboard. A simple example site you can use is [https://webhook.site/#!/]([url](https://webhook.site/#!/)), but use whichever Webhooks site you prefer.
69+
3. 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.
70+
4. Add the endpoint you copied from Step 2, to the Webhook Actions Mapping's URL in Step 3.
71+
5. Enable the Mapping.
72+
6. Enable the Webhook Actions destination.
73+
7. Begin sending events to your source. Verify those events throughout the Segment pipeline (source debugger/ event delivery), and 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.

0 commit comments

Comments
 (0)