@@ -18,4 +18,55 @@ Segment maintains this destination. For any issues, [contact Segment Support](fr
18
18
19
19
By default, the new destination is disabled. You'll enable it in the next section.
20
20
21
- ## 2.
21
+ ## 2. Set up authentication
22
+
23
+ Before you can enable the new destination, you'll first need to choose an authentication option:
24
+
25
+ 1 . On the new destination's page, navigate to ** Settings > Authentication.**
26
+ 2 . Choose one of the following authentication options:
27
+ - ** No authentication** : Segment doesn't manage authentication.
28
+ - ** Bearer token** : Segment automatically includes a bearer token in the API request header.
29
+ - ** OAuth 2.0** : Segment manages the OAuth token lifecycle, including fetching and refreshing tokens.
30
+ 3 . For OAuth 2.0, select one of the following flows:
31
+ - ** Authorization code** , which requires the following fields:
32
+ - Client ID
33
+ - Client secret
34
+ - Authorize URL
35
+ - Access Token URL
36
+ - Refresh Token URL (usually the same as the Access Token URL)
37
+ - Scopes
38
+ - ** Use client credentials** , which requires the following:
39
+ - Client ID
40
+ - Client Secret
41
+ - Access Token URL
42
+ - Refresh Token URL (usually the same as the Access Token URL)
43
+ - Scope
44
+ 4 . Save the settings, then click ** Connect** to activate the connection.
45
+
46
+ You've now completed setup, and your destination is ready for event mapping and data configuration.
47
+
48
+ ## Mapping and data configuration
49
+
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:
55
+ - 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
+
59
+ > ** Note** : Segment supports batching the entire payload but not specific objects within the payload.
60
+
61
+ ## Known limitations
62
+
63
+ - ** Token Expiration Issue** : If a token expires before a test event is sent, the test event may fail with a 401 error. Workarounds include:
64
+ 1 . Using the ** Event Tester** to validate connections.
65
+ 2 . Reconnecting OAuth by editing and saving settings to fetch a new token.
66
+
67
+ ## Enabling the destination
68
+
69
+ 1 . Enable the destination in the ** Settings** page if it is not already enabled.
70
+ 2 . Save the configuration to ensure "Extensible Webhooks" is live.
71
+
72
+
0 commit comments