@@ -29,39 +29,43 @@ If the `user_id` passed is _valid and known_, and the `group_id` passed is _vali
2929
3030If the ` user_id ` passed is _ invalid_ , an error will be returned.
3131
32- ### Supported data parameters:
33- | Segment key | Type | Cordial mapping |
34- | ------------- | :-------------:| -----|
35- | ` user_id ` | string | email address or custom primary key |
36- | ` group_id ` | string | list ID |
32+ ### Supported data parameters
33+
34+ | Segment key | Type | Cordial mapping |
35+ | ----------- | :------:| ----------------------------------- |
36+ | ` user_id ` | string | email address or custom primary key |
37+ | ` group_id ` | string | list ID |
3738
3839## Track
3940If the ` user_id ` passed is _ valid and known_ , the event and its properties will be attributed to the contact in Cordial.
4041
4142If the ` user_id ` passed is _ invalid_ , an error will be returned.
4243
43- ### Supported data parameters:
44- | Segment key | Type | Cordial mapping |
45- | ------------- | :-------------:| -----|
46- | ` user_id ` | string | email address or custom primary key |
47- | ` event ` | string | event name |
48- | ` properties ` | object | event properties (optional) |
44+ ### Supported data parameters
45+
46+ | Segment key | Type | Cordial mapping |
47+ | ------------ | :------:| ----------------------------------- |
48+ | ` user_id ` | string | email address or custom primary key |
49+ | ` event ` | string | event name |
50+ | ` properties ` | object | event properties (optional) |
4951
5052## Page
5153If the ` user_id ` passed is _ valid and known_ , a page view event will be attributed to the contact in Cordial.
5254
5355If the ` user_id ` passed is _ invalid_ , an error will be returned.
56+
5457### Supported data parameters:
55- | Segment key | Type | Cordial mapping |
56- | ------------- | :-------------:| -----|
57- | ` user_id ` | string | email address or custom primary key |
58+
59+ | Segment key | Type | Cordial mapping |
60+ | ----------- | :------:| ----------------------------------- |
61+ | ` user_id ` | string | email address or custom primary key |
5862
5963## Optional advanced configuration
6064
61- ### POST https://admin.cordial.io/api/integrations/segment
65+ ` POST https://admin.cordial.io/api/integrations/segment `
6266This endpoint can be used to configure custom mappings for your Segment destination.
6367
64- ```
68+ ``` js
6569{ " name" : " segment" ,
6670 " enabled" : true ,
6771 " attributeMapping" : [
@@ -73,10 +77,11 @@ This endpoint can be used to configure custom mappings for your Segment destinat
7377 " ignoreFields" : [" website" ],
7478 " contactsErrorHandling" : " ignoreMissingAttributes" }
7579```
80+
7681You will be asked to authenticate. Use your Cordial API key as the username and proceed with the password blank. (To do this, log in to your Cordial account and open the dropdown menu in the top right corner. Navigate to Administration > API Keys. Here you will create a new key by whitelisting your IP with us.)
7782
78- ### PUT https://admin.cordial.io/api/integrations/segment
83+ ` PUT https://admin.cordial.io/api/integrations/segment `
7984Update your Cordial/Segment field mapping using the same JSON format as in the POST call.
8085
81- ### GET https://admin.cordial.io/api/integrations
86+ ` GET https://admin.cordial.io/api/integrations `
8287Retrieve a JSON list of integrations you have set up with Cordial.
0 commit comments