From 35c64ea0f7b35a667bb3caae0724780d0f082d05 Mon Sep 17 00:00:00 2001 From: Casie Oxford Date: Mon, 22 Apr 2024 10:41:17 -0500 Subject: [PATCH 1/5] Adding FAQs this is a redo of this item: https://github.com/segmentio/segment-docs/pull/5101 as it won't pass Snyk. --- .../catalog/actions-webhook/index.md | 44 +++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/src/connections/destinations/catalog/actions-webhook/index.md b/src/connections/destinations/catalog/actions-webhook/index.md index 3eaf83f345..fcb3e1621e 100644 --- a/src/connections/destinations/catalog/actions-webhook/index.md +++ b/src/connections/destinations/catalog/actions-webhook/index.md @@ -27,3 +27,47 @@ Segment's Webhooks (Actions) destination uses internet protocol and HTTP callbac ## 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`. + +--- +title: Webhooks (Actions) Destination +hide-boilerplate: true +hide-dossier: false +id: 614a3c7d791c91c41bae7599 +versions: + - name: 'Webhooks (Classic)' + link: '/docs/connections/destinations/catalog/webhooks' +--- + +{% include content/plan-grid.md name="actions" %} + +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 + +1. From the Segment web app, navigate to **Connections > Catalog**. +2. Search for **Webhooks (Actions)** in the Destinations Catalog, and select the destination. +3. Click **Configure Webhooks (Actions)**. +4. Select the source that will send data to Webhooks (Actions) and follow the steps to name your destination. +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. +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. +7. Enable the destination and configured mappings. + +{% include components/actions-fields.html settings="true"%} + +## 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 +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. +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. +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. +4. Add the endpoint you copied from Step 2, to the Webhook Actions Mapping's URL in Step 3. +5. Enable the Mapping. +6. Enable the Webhook Actions destination. +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. From 893186b03238a473676b72a3e9bdd24fdf2cb768 Mon Sep 17 00:00:00 2001 From: Casie Oxford Date: Mon, 22 Apr 2024 10:46:08 -0500 Subject: [PATCH 2/5] got carried away with copy --- .../catalog/actions-webhook/index.md | 30 ------------------- 1 file changed, 30 deletions(-) diff --git a/src/connections/destinations/catalog/actions-webhook/index.md b/src/connections/destinations/catalog/actions-webhook/index.md index fcb3e1621e..5d6d280fd0 100644 --- a/src/connections/destinations/catalog/actions-webhook/index.md +++ b/src/connections/destinations/catalog/actions-webhook/index.md @@ -28,36 +28,6 @@ Segment's Webhooks (Actions) destination uses internet protocol and HTTP callbac 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`. ---- -title: Webhooks (Actions) Destination -hide-boilerplate: true -hide-dossier: false -id: 614a3c7d791c91c41bae7599 -versions: - - name: 'Webhooks (Classic)' - link: '/docs/connections/destinations/catalog/webhooks' ---- - -{% include content/plan-grid.md name="actions" %} - -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 - -1. From the Segment web app, navigate to **Connections > Catalog**. -2. Search for **Webhooks (Actions)** in the Destinations Catalog, and select the destination. -3. Click **Configure Webhooks (Actions)**. -4. Select the source that will send data to Webhooks (Actions) and follow the steps to name your destination. -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. -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. -7. Enable the destination and configured mappings. - -{% include components/actions-fields.html settings="true"%} - -## 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? From 6b4a009f5ab00487a9ad63fc7c90ffc8d5e32c48 Mon Sep 17 00:00:00 2001 From: Casie Oxford Date: Wed, 29 May 2024 15:43:39 -0500 Subject: [PATCH 3/5] Update index.md --- src/connections/destinations/catalog/actions-webhook/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/actions-webhook/index.md b/src/connections/destinations/catalog/actions-webhook/index.md index 5d6d280fd0..ac17e43b6a 100644 --- a/src/connections/destinations/catalog/actions-webhook/index.md +++ b/src/connections/destinations/catalog/actions-webhook/index.md @@ -35,7 +35,7 @@ The easiest way to test whether a source's events are sending through the Segmen #### Connect a Webhook Actions destination to your workspace 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. -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. +2. Visit the webhook's site, and copy the endpoint to your clipboard. An example site you can use is [https://webhook.site/#!/]([url](https://webhook.site/#!/)), but use whichever webhooks site you prefer. 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. 4. Add the endpoint you copied from Step 2, to the Webhook Actions Mapping's URL in Step 3. 5. Enable the Mapping. From c92bfa3f4ae9d667998d6d73bb13de71a8118906 Mon Sep 17 00:00:00 2001 From: Casie Oxford Date: Wed, 29 May 2024 15:43:52 -0500 Subject: [PATCH 4/5] Apply suggestions from code review Co-authored-by: pwseg <86626706+pwseg@users.noreply.github.com> --- src/connections/destinations/catalog/actions-webhook/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/actions-webhook/index.md b/src/connections/destinations/catalog/actions-webhook/index.md index ac17e43b6a..00b4c51c37 100644 --- a/src/connections/destinations/catalog/actions-webhook/index.md +++ b/src/connections/destinations/catalog/actions-webhook/index.md @@ -37,7 +37,7 @@ The easiest way to test whether a source's events are sending through the Segmen 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. 2. Visit the webhook's site, and copy the endpoint to your clipboard. An example site you can use is [https://webhook.site/#!/]([url](https://webhook.site/#!/)), but use whichever webhooks site you prefer. 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. -4. Add the endpoint you copied from Step 2, to the Webhook Actions Mapping's URL in Step 3. +4. Add the endpoint you copied from Step 2 to the Webhook Actions Mapping's URL in Step 3. 5. Enable the Mapping. 6. Enable the Webhook Actions destination. 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. From eb1f3b583c3cdae635fdea6b0fb6c31dec2da89a Mon Sep 17 00:00:00 2001 From: Casie Oxford Date: Wed, 29 May 2024 15:45:10 -0500 Subject: [PATCH 5/5] Update index.md --- src/connections/destinations/catalog/actions-webhook/index.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/actions-webhook/index.md b/src/connections/destinations/catalog/actions-webhook/index.md index 00b4c51c37..c3fe75bf68 100644 --- a/src/connections/destinations/catalog/actions-webhook/index.md +++ b/src/connections/destinations/catalog/actions-webhook/index.md @@ -40,4 +40,6 @@ The easiest way to test whether a source's events are sending through the Segmen 4. Add the endpoint you copied from Step 2 to the Webhook Actions Mapping's URL in Step 3. 5. Enable the Mapping. 6. Enable the Webhook Actions destination. -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. +7. Begin sending events to your source. +8. Verify those events throughout the Segment pipeline (source debugger/ event delivery). +9. 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.