Skip to content

Commit a9d446f

Browse files
committed
doc: add documentation for the Matilda (Actions) destination
1 parent 747b35d commit a9d446f

1 file changed

Lines changed: 141 additions & 0 deletions

File tree

  • src/connections/destinations/catalog/matilda
Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
# Matilda (Actions) Destination
2+
3+
## Destination overview
4+
5+
The Matilda (Actions) destination supports `Identify`, `Group`, and `Track` calls.
6+
7+
- In Segment, this destination appears as `Matilda (Actions)` in the Integrations object.
8+
- This is a partner-owned destination. For setup or support issues, contact the Matilda support team.
9+
- This destination is currently in beta.
10+
11+
Matilda helps teams manage customer relationships, coordinate work, and automate workflows with AI-powered agents.
12+
With this destination, you can use your existing Segment events to create and update records in Matilda.
13+
For example, an Identify call can create or update a User and connect that user to a Person in Matilda.
14+
15+
## Getting started
16+
17+
1. In Segment, open Catalog and select Destinations.
18+
2. Search for `Matilda (Actions)` and add it as a destination.
19+
3. Follow the setup steps in Segment.
20+
4. In Matilda, go to Settings and select Segment from the sidebar.
21+
5. Copy your API key from Matilda, then paste it into the Matilda (Actions) destination configuration in Segment.
22+
23+
## Identify: create or update users and people
24+
25+
Use Identify calls to create or update a User record in Matilda.
26+
27+
When an Identify call includes an email address, Matilda will:
28+
29+
- create or update the User using that email address
30+
- look for an existing Person with the same email address
31+
- link the User to that Person if one exists
32+
- create a new Person if no matching Person is found
33+
34+
By default, this mapping runs on Identify events.
35+
36+
### Understanding Users and People
37+
38+
In Matilda:
39+
40+
- a Person represents a real human
41+
- a User represents that person as a user inside your product or SaaS application
42+
43+
A single Person can be related to multiple Users.
44+
For example, the same person may appear in different products, accounts, or workspaces, while still being the same underlying human.
45+
46+
### Required fields
47+
48+
This mapping assumes your Identify call includes:
49+
50+
- an email address, used to create or update the User and match or create the related Person
51+
- an id, used as the external identifier for the User
52+
53+
### Additional attributes
54+
55+
You can map extra fields from your Segment event to Matilda attributes.
56+
For example, you might send product-specific properties such as role, plan, status, or permissions as additional attributes on the User or Person.
57+
58+
On the Edit Mapping page:
59+
60+
- the left column should contain values from your Segment event, or custom text
61+
- the right column should contain the Matilda attribute slug or ID you want to map to
62+
63+
> Info
64+
> Every Matilda attribute has both an ID and a slug. You can use either one in this destination.
65+
> To find an attribute slug, go to the relevant object settings page, open the Attributes tab, find the attribute, click the ︙ menu, and select Copy slug.
66+
67+
> Note
68+
> By default, the User object includes only a small set of attributes. In most cases, you should create any custom User attributes you need in Matilda before sending Identify calls.
69+
70+
## Group: create or update workspaces and companies
71+
72+
Use Group calls to create or update a Workspace record in Matilda.
73+
74+
This mapping uses two keys:
75+
76+
- `domain` (required)
77+
- `groupId` or `workspaceId` (optional secondary key)
78+
79+
When a Group call includes a domain, Matilda will:
80+
81+
- create or update the Workspace/Company record using domain as the primary unique key
82+
- if `groupId` or `workspaceId` is present, use it as a secondary key for better matching
83+
- link or update the related company/workspace record
84+
85+
If no domain is included, Matilda ignores workspace/company create or update for that Group event.
86+
87+
By default, this mapping runs on Group events.
88+
89+
### Understanding Workspaces and Companies
90+
91+
In Matilda:
92+
93+
- a Company represents a real company
94+
- a Workspace represents a workspace, tenant, account, or group inside your product
95+
96+
A Company can be related to multiple Workspaces, and a Workspace can be associated with the Company that it belongs to.
97+
98+
### Required and optional fields
99+
100+
This mapping assumes your Group call includes:
101+
102+
- a required domain, used to match or create the company/workspace record
103+
- an optional id (`groupId` or `workspaceId`) used as a secondary unique key
104+
105+
### Additional attributes
106+
107+
You can also map extra event properties to Workspace or Company attributes.
108+
For example, you might send fields like billing plan, workspace size, lifecycle stage, region, or account owner as additional attributes.
109+
110+
On the Edit Mapping page:
111+
112+
- the left column should contain values from your Segment event, or custom text
113+
- the right column should contain the Matilda attribute slug or ID you want to map to
114+
115+
> Info
116+
> Every Matilda attribute has both an ID and a slug. You can use either one in this destination.
117+
> To find an attribute slug, go to the relevant object settings page, open the Attributes tab, find the attribute, click the ︙ menu, and select Copy slug.
118+
119+
> Note
120+
> By default, the Workspace object includes only a limited set of attributes. You will usually want to create your own custom Workspace attributes in Matilda before sending Group calls.
121+
122+
## Track support
123+
124+
The destination accepts Track calls and can map attributes for downstream activity and enrichment flows.
125+
Use Identify and Group as the primary create/update flows for user/person and workspace/company entities.
126+
127+
## Data model summary
128+
129+
Matilda separates real-world entities from product-specific entities:
130+
131+
- People and Companies represent real people and real companies
132+
- Users and Workspaces represent those entities inside your product or connected SaaS apps
133+
134+
Because of this model:
135+
136+
- one Person can be linked to many Users
137+
- one Company can be linked to many Workspaces
138+
- users and workspaces can carry product-specific attributes
139+
- people and companies can act as the shared real-world records behind them
140+
141+
This structure makes it easier to unify customer data across products, workspaces, and accounts.

0 commit comments

Comments
 (0)