Skip to content

Conversation

lizkane222
Copy link
Contributor

Proposed changes

I added a section under FAQ to illustrate how easy it is to test Segment's connections pipeline end-to-end.

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, triggering the event to send to the Source which sends the event to its connected Destination. By following the steps below you'll understand how 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 were to connect a Webhooks Destination (Webhook Actions Destination) to your source, you'd be able to easily see the events received by that source and sent to that destination, proving the events have made it successfully end-to-end.

Steps to get a Webhook Actions destination connected to your workspace.

  1. Add a new Webhook (Actions) destination to your source : link to add Webhooks Actions destination. Make sure you select the intended source to connect this destination to.
  2. Visit the Webhook's site, and copy the Webhook's endpoint to clipboard : a simple example site you can use is 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 the Source, and verifying those events throughout the Segment pipeline (source debugger / event delivery), and finally at the webhook's website, which will show the raw JSON for all of the events that were successfully received by your Segment Source and its Webhooks Actions destination.

Merge timing

  • ASAP once approved?

Related issues (optional)

Also creating another PR for other doc

@lizkane222
Copy link
Contributor Author

Other PR : #5102

@cmastr cmastr added the KCS label Jan 25, 2024
@cmastr cmastr marked this pull request as ready for review January 25, 2024 15:29
@cmastr cmastr requested a review from a team as a code owner January 25, 2024 15:29
@cmastr cmastr requested review from rchinn1 and removed request for a team January 25, 2024 15:29
Co-authored-by: rchinn-segment <93161299+rchinn-segment@users.noreply.github.com>
@cmastr cmastr requested review from rchinn1 and removed request for rchinn1 March 20, 2024 19:00
@cmastr cmastr removed the request for review from rchinn1 April 17, 2024 21:00
cmastr added a commit that referenced this pull request Apr 22, 2024
this is a redo of this item:

#5101 

as it won't pass Snyk.
@cmastr cmastr mentioned this pull request Apr 22, 2024
@cmastr
Copy link
Contributor

cmastr commented Apr 22, 2024

Closing in favor of #6419

@cmastr cmastr closed this Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants