Skip to content

Update index.md Webhooks Actions destination FAQ end to end test #5102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

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 : #5101

@lizkane222 lizkane222 marked this pull request as ready for review July 24, 2024 21:57
@lizkane222 lizkane222 requested a review from a team as a code owner July 24, 2024 21:57
@lizkane222 lizkane222 requested a review from pwseg July 24, 2024 21:57
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.

2 participants