Skip to content

Commit acdf360

Browse files
committed
add mapping instructions
1 parent 45cd330 commit acdf360

File tree

1 file changed

+18
-8
lines changed
  • src/connections/destinations/catalog/actions-webhook-extensible

1 file changed

+18
-8
lines changed

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

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,16 +45,25 @@ Before you can enable the new destination, you'll first need to choose an authen
4545

4646
You've now completed setup, and your destination is ready for event mapping and data configuration.
4747

48-
## Mapping and data configuration
48+
## 3. Mapping and data configuration (optional)
4949

50-
1. Define the API endpoint (URL) and the HTTP method (POST, PATCH, PUT).
51-
2. Configure optional parameters:
52-
- **Batch Size**: Specify batch size if the API supports batching entire payloads.
53-
- **Headers**: Add required headers (e.g., `content-type` defaults to `application/json`).
54-
3. Map payload fields:
50+
With authentication in place, you can now define how data flows from Segment to your webhook endpoints. Follow these steps to configure mappings and test the setup:
51+
52+
1. From your destination's setting page, click **Mappings**, then **+New Mapping**.
53+
2. On the Activate data screen, select the action you want to use.
54+
3. Define your event trigger, then click **Load Test Event From Source**.
55+
4. In the Map field section, define the API endpoint (URL) and the HTTP method (`POST`, `PATCH`, `PUT`).
56+
5. Map payload fields:
5557
- Map individual fields or select a specific object from a test event.
56-
- (Optional) Use a destination insert function to transform the payload according to the API specification.
57-
4. Send a test event to validate the setup. Debug any errors related to payload configuration or authentication.
58+
- (Optional) Use a [destination insert function](/docs/connections/functions/insert-functions/) to transform the payload according to the API specification.
59+
6. Configure optional parameters:
60+
- **Batch size**: Specify batch size if the API supports batching entire payloads.
61+
- **Headers**: Add required headers (for example, `content-type`, which is required, defaults to `application/json`).
62+
7. Send a test event to validate the setup. Segment logs the response from your destination so that you can debug any errors (which are usually related to the payload configuration or authentication issues).
63+
8. Click **Save**, then click **Next**.
64+
9. Give your mapping a name, then click **Save and enable**.
65+
66+
Your mapping is now enabled.
5867

5968
> **Note**: Segment supports batching the entire payload but not specific objects within the payload.
6069
@@ -69,4 +78,5 @@ You've now completed setup, and your destination is ready for event mapping and
6978
1. Enable the destination in the **Settings** page if it is not already enabled.
7079
2. Save the configuration to ensure "Extensible Webhooks" is live.
7180

81+
Congratulations! Your Extensible Webhooks destination is now set up and ready to send data to your webhook endpoints.
7282

0 commit comments

Comments
 (0)