Schematic (Actions) Destination
Schematic enables you to launch, package, meter, and monitor features with ease, so you can manage it all in one place as your business grows.
Segment is the easiest way to send events from your application to Schematic. If you already have Segment up and running in your application, Schematic recommends this approach so you don’t have to implement any additional code.
Schematic maintains this destination. For any issues with the destination, contact the Schematic Support team.
Getting started
- From your Segment web app, navigate to Connections > Catalog > Destinations.
- Search for Schematic, select the Schematic destination, and click Add destination.
- Select the source that will send data to Schematic, give your destination a name, then click Create destination.
- On the destination’s Settings tab, input your Schematic API Key. To generate an API key, navigate to your Schematic workspace settings under Settings > API Keys.
Once you’ve connected Schematic to Segment, you can configure how you want to send data to Schematic in the Schematic destination’s Mappings tab.
Destination Settings
Setting | Description |
---|---|
API Key | Required. Found on your settings page. |
Available Presets
Schematic has the following presets:
Preset Name | Trigger | Default Action |
---|---|---|
Track Event | Event type = "track" |
Track Event |
Identify User | Event type = "identify" |
Identify User |
Available Actions
Build your own Mappings. Combine supported triggers with the following Schematic-supported actions:
Mapping limits per destination
Individual destination instances have support a maximum of 50 mappings.
Track Event
Send track events to Schematic
Track Event is a Cloud action. The default Trigger is: type = "track"
Field | Description |
---|---|
Event name* | Type: STRING Name of event (this will be snake cased in request) |
Company keys | Type: OBJECT Key-value pairs associated with a company (e.g. organization_id: 123456) |
Timestamp* | Type: DATETIME Time the event took place |
User keys | Type: OBJECT Key-value pairs associated with a user (e.g. email: example@example.com) |
Traits | Type: OBJECT Additional properties to send with event |
Identify User
Send identify events to Schematic
Identify User is a Cloud action. The default Trigger is: type = "identify"
Field | Description |
---|---|
Company keys* | Type: OBJECT Key-value pairs associated with a company (e.g. organization_id: 123456) |
Company name | Type: STRING Name of company |
Company traits | Type: OBJECT Properties associated with company |
Timestamp* | Type: DATETIME Time the event took place |
User keys* | Type: OBJECT Key-value pairs associated with a user (e.g. email: example@example.com) |
User name | Type: STRING User’s full name |
User traits | Type: OBJECT Properties associated with user |
Additional Context
Schematic only accepts Track event names that contain alphanumeric characters, dashes, and underscores. If Segment event names have other characters, like spaces, the Schematic destination automatically snake_cases the event name before passing to Schematic. Segment passes the raw event name as an event trait.
Engage
You can send computed traits and audiences generated using Engage to this destination as a user property. To learn more about Engage, schedule a demo.
For user-property destinations, an identify call is sent to the destination for each user being added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Engage sends an Identify call with the property order_completed_last_30days: true
. When the user no longer satisfies this condition (for example, it’s been more than 30 days since their last order), Engage sets that value to false
.
When you first create an audience, Engage sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.
Real-time to batch destination sync frequency
Real-time audience syncs to Schematic (Actions) may take six or more hours for the initial sync to complete. Upon completion, a sync frequency of two to three hours is expected.
Settings
Segment lets you change these destination settings from the Segment app without having to touch any code.
Setting | Description |
---|---|
API Key (required) |
string . Found on your settings page. |
This page was last modified: 07 Aug 2024
Need support?
Questions? Problems? Need more info? Contact Segment Support for assistance!