The Segment synapse enables data synchronization between segment and Syncari entities using the Segment API. After you authenticate with Segment, you can activate the synapse, which enables Syncari to make the data available within the Syncari Unified Data Model.
Segment Setup
To authenticate with the Segment synapse, you will need to know the Shared Secret and webhook Identifier. Keep this information handy. You will need it to Configure the Segment Synapse in Syncari.
To find your Shared Secret and webhook Identifier:
Navigate to the workspace: Log in to your segment account and access the relevant workspace (e.g., “Ultimsoft_shivakumar”).
Locate the “add source” option:
On the left navigation bar, click on “sources.” Look for the “add a source” option click the “add source” button.
The “Add a Source” will take you to the “Catalog” option in the left navigation bar. Here you’ll find available “Sources” in segment. For this example, we are using the HTTP API source .Add Source by clicking on HTTP API.
Give the name (e.g., HTTP API) and labels of source. Click on add source. The source gets created.
In the catalog on the left-hand menu, you have an option to search on the top right. Search “webhook".
Webhooks (actions) is the destination to click on.
Select the source you will be adding the destination to
Give the destination a name. Click “create destination”
Once the destination is created. Move to the settings tab in the webhook view to create the shared secret. The shared secret can be whatever you want. It will be used it activate synapse.
Then enable the destination using toggle button.Now Your Destination Created Successfully.
Navigate to mapping tab and click on new mapping.
The pop-up will display action options. Choose sent an http request.
You can specify what kind of event must go through this action (if you send a different event type than specified, nothing will be received by the webhook.)
You can load sample data, or you can load a test you have sent to the HTTP source before the mapping set up. This will be the schema the webhook is expecting.
The URL is where you will paste the syncari endpoint (Link format: - https://app.syncari.com/arcade/api/v1/webhooks/segment_global?webhookIdentifier=<webhookIdentifer> Identifier is the combination of Segment workspace name and Syncari Instance Id from Settings -> Subscription Profile. For example, myworkspace_JHTW36)
-
- There are additional settings specifying the method type, batch size, and other possible parameters.
- There are additional settings specifying the method type, batch size, and other possible parameters.
Test the connection to ensure data is correctly sent to the destination. Save the mapping configuration.
The default status is disabled when mapping is newly created. You can enable it by toggling the switch in the status tab.
And go to Event tester tab is used to test the webhook directly from segment.
NOTE: The Segment Synapse follows a specific schema where field names created in Segment will have to match with the ones in Syncari. Here are the schemas and data types for each.
Event:
| API Name | Data Type |
| Messageid | String |
| String | |
| Channel | String |
| Name | String |
| Anonymousid | String |
| Userid | String |
| Type | String |
| Version | String |
| Context | Object |
| Event | String |
| Projectid | String |
| Properties | Object |
| Integrations | String |
| Receivedat | Datetime |
| Sentat | Datetime |
| Originaltimestamp | Datetime |
| Timestamp | Datetime |
| Syncarireceivedat | Timestamp |
Identity:
| Name | Data Type |
| Messageid | String |
| Userid | String |
| Type | String |
| Version | String |
| Context | Object |
| Projectid | String |
| Traits | Object |
| Integrations | Object |
| Receivedat | Datetime |
| Originaltimestamp | Datetime |
| Timestamp | Datetime |
| Syncarireceivedat | Timestamp |
Configure the Segment Synapse in Syncari
In the previous session, you identified the Shared Secret and webhook Identifier. Now, you can connect the segment synapse in Syncari:
In Syncari, open Synapse Studio. Find segment in the Synapse Library, and drag it to the canvas.
Complete the information in the Configure step:
- Synapse Name—Enter your own custom name for the synapse.
Note: Stick to letters and numbers. The name must begin with a letter. The only special characters we allow are spaces, hyphens (-), and underscores (_).
- Enter webhook Identifier (Identifier is the combination of Segment workspace name and Syncari Instance Id from Settings -> Subscription Profile. For example, myworkspace_JHTW36) that you identified in Segment Setup.
- Authentication Method—Leave None selected.
- Optional: The Sync Rate Limit affects downstream syncs with the synapse. Turn on the Sync Rate Limit if needed to limit the sync rate for updates. You can edit this configuration later if you find you need to manage your downstream syncs.
Click Next. Enter the Shared Secret
Click Authenticate. Select Make Synapse Active.