Skip to content

Commit 8db43b7

Browse files
waleedlatif1waleedlatif1
committed
update docs
1 parent edf3c0d commit 8db43b7

File tree

1 file changed

+54
-54
lines changed

1 file changed

+54
-54
lines changed

‎apps/docs/content/docs/en/tools/attio.mdx‎

Lines changed: 54 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,21 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
1010
color="#1D1E20"
1111
/>
1212

13+
{/* MANUAL-CONTENT-START:intro */}
14+
[Attio](https://www.attio.com/) is a modern and flexible CRM platform built to help teams manage relationships, data, and workflows more efficiently. Attio enables organizations to create and organize custom objects (like people, companies, deals, and more), manage notes and tasks, collaborate as a team, and automate work across their relationship and data pipelines.
15+
16+
With Attio, you can:
17+
18+
- **Manage records for any object**: Store and organize people, companies, or any custom objects to fit your team's needs.
19+
- **Track, connect, and update information**: Add and edit notes, comments, tasks, and linked records so your contextual data is always in sync.
20+
- **Build and customize lists**: Segment records, filter and sort with powerful queries, and build views that fit your workflow.
21+
- **Collaborate with your team**: Assign tasks, share comments, and see activities in real time.
22+
- **Automate CRM workflows**: Create, update, and read record data via API to keep your tools and teams in the loop, or trigger actions as relationships evolve.
23+
24+
In Sim, the Attio integration lets your agents programmatically query lists, fetch and manipulate records, manage entries, tasks, comments, and more—making it easy to automate CRM operations, enrich data, synchronize with other systems, or trigger workflow automations based on relationship or record events. Use these tools to ensure your CRM stays up-to-date and powerful directly from within your Sim projects.
25+
{/* MANUAL-CONTENT-END */}
26+
27+
1328
## Usage Instructions
1429

1530
Connect to Attio to manage CRM records (people, companies, custom objects), notes, tasks, lists, list entries, comments, workspace members, and webhooks.
@@ -38,11 +53,11 @@ Query and list records for a given object type (e.g. people, companies)
3853
| --------- | ---- | ----------- |
3954
| `records` | array | Array of Attio records |
4055
| ↳ `id` | object | The record identifier |
41-
| ↳ `workspaceId` | string | The workspace ID |
42-
| ↳ `objectId` | string | The object ID |
43-
| ↳ `recordId` | string | The record ID |
44-
| ↳ `createdAt` | string | When the record was created |
45-
| ↳ `webUrl` | string | URL to view the record in Attio |
56+
| ↳ `workspace_id` | string | The workspace ID |
57+
| ↳ `object_id` | string | The object ID |
58+
| ↳ `record_id` | string | The record ID |
59+
| ↳ `created_at` | string | When the record was created |
60+
| ↳ `web_url` | string | URL to view the record in Attio |
4661
| ↳ `values` | json | The record attribute values |
4762
| `count` | number | Number of records returned |
4863

@@ -63,11 +78,11 @@ Get a single record by ID from Attio
6378
| --------- | ---- | ----------- |
6479
| `record` | object | An Attio record |
6580
| ↳ `id` | object | The record identifier |
66-
| ↳ `workspaceId` | string | The workspace ID |
67-
| ↳ `objectId` | string | The object ID |
68-
| ↳ `recordId` | string | The record ID |
69-
| ↳ `createdAt` | string | When the record was created |
70-
| ↳ `webUrl` | string | URL to view the record in Attio |
81+
| ↳ `workspace_id` | string | The workspace ID |
82+
| ↳ `object_id` | string | The object ID |
83+
| ↳ `record_id` | string | The record ID |
84+
| ↳ `created_at` | string | When the record was created |
85+
| ↳ `web_url` | string | URL to view the record in Attio |
7186
| ↳ `values` | json | The record attribute values |
7287
| `recordId` | string | The record ID |
7388
| `webUrl` | string | URL to view the record in Attio |
@@ -89,11 +104,11 @@ Create a new record in Attio for a given object type
89104
| --------- | ---- | ----------- |
90105
| `record` | object | An Attio record |
91106
| ↳ `id` | object | The record identifier |
92-
| ↳ `workspaceId` | string | The workspace ID |
93-
| ↳ `objectId` | string | The object ID |
94-
| ↳ `recordId` | string | The record ID |
95-
| ↳ `createdAt` | string | When the record was created |
96-
| ↳ `webUrl` | string | URL to view the record in Attio |
107+
| ↳ `workspace_id` | string | The workspace ID |
108+
| ↳ `object_id` | string | The object ID |
109+
| ↳ `record_id` | string | The record ID |
110+
| ↳ `created_at` | string | When the record was created |
111+
| ↳ `web_url` | string | URL to view the record in Attio |
97112
| ↳ `values` | json | The record attribute values |
98113
| `recordId` | string | The ID of the created record |
99114
| `webUrl` | string | URL to view the record in Attio |
@@ -116,11 +131,11 @@ Update an existing record in Attio (appends multiselect values)
116131
| --------- | ---- | ----------- |
117132
| `record` | object | An Attio record |
118133
| ↳ `id` | object | The record identifier |
119-
| ↳ `workspaceId` | string | The workspace ID |
120-
| ↳ `objectId` | string | The object ID |
121-
| ↳ `recordId` | string | The record ID |
122-
| ↳ `createdAt` | string | When the record was created |
123-
| ↳ `webUrl` | string | URL to view the record in Attio |
134+
| ↳ `workspace_id` | string | The workspace ID |
135+
| ↳ `object_id` | string | The object ID |
136+
| ↳ `record_id` | string | The record ID |
137+
| ↳ `created_at` | string | When the record was created |
138+
| ↳ `web_url` | string | URL to view the record in Attio |
124139
| ↳ `values` | json | The record attribute values |
125140
| `recordId` | string | The ID of the updated record |
126141
| `webUrl` | string | URL to view the record in Attio |
@@ -184,11 +199,11 @@ Upsert a record in Attio — creates it if no match is found, updates it if a ma
184199
| --------- | ---- | ----------- |
185200
| `record` | object | The upserted record |
186201
| ↳ `id` | object | The record identifier |
187-
| ↳ `workspaceId` | string | The workspace ID |
188-
| ↳ `objectId` | string | The object ID |
189-
| ↳ `recordId` | string | The record ID |
190-
| ↳ `createdAt` | string | When the record was created |
191-
| ↳ `webUrl` | string | URL to view the record in Attio |
202+
| ↳ `workspace_id` | string | The workspace ID |
203+
| ↳ `object_id` | string | The object ID |
204+
| ↳ `record_id` | string | The record ID |
205+
| ↳ `created_at` | string | When the record was created |
206+
| ↳ `web_url` | string | URL to view the record in Attio |
192207
| ↳ `values` | json | The record attribute values |
193208
| `recordId` | string | The record ID |
194209
| `webUrl` | string | URL to view the record in Attio |
@@ -531,7 +546,7 @@ List all lists in the Attio workspace
531546
| ↳ `name` | string | The list name |
532547
| ↳ `parentObject` | string | The parent object slug \(e.g. people, companies\) |
533548
| ↳ `workspaceAccess` | string | Workspace-level access \(e.g. full-access, read-only\) |
534-
| ↳ `workspaceMemberAccess` | string | Member-level default access |
549+
| ↳ `workspaceMemberAccess` | json | Member-level access entries |
535550
| ↳ `createdByActor` | object | The actor who created the list |
536551
| ↳ `type` | string | The actor type \(e.g. workspace-member, api-token, system\) |
537552
| ↳ `id` | string | The actor ID |
@@ -557,7 +572,7 @@ Get a single list by ID or slug
557572
| `name` | string | The list name |
558573
| `parentObject` | string | The parent object slug \(e.g. people, companies\) |
559574
| `workspaceAccess` | string | Workspace-level access \(e.g. full-access, read-only\) |
560-
| `workspaceMemberAccess` | string | Member-level default access |
575+
| `workspaceMemberAccess` | json | Member-level access entries |
561576
| `createdByActor` | object | The actor who created the list |
562577
| ↳ `type` | string | The actor type \(e.g. workspace-member, api-token, system\) |
563578
| ↳ `id` | string | The actor ID |
@@ -574,8 +589,8 @@ Create a new list in Attio
574589
| `name` | string | Yes | The list name |
575590
| `apiSlug` | string | No | The API slug for the list \(auto-generated from name if omitted\) |
576591
| `parentObject` | string | Yes | The parent object slug \(e.g. people, companies\) |
577-
| `workspaceAccess` | string | No | Workspace-level access: full-access, read-and-write, read-only, or none |
578-
| `workspaceMemberAccess` | string | No | Default member access: full-access, read-and-write, read-only, or none |
592+
| `workspaceAccess` | string | No | Workspace-level access: full-access, read-and-write, or read-only \(omit for private\) |
593+
| `workspaceMemberAccess` | string | No | JSON array of member access entries, e.g. \[\{"workspace_member_id":"...","level":"read-and-write"\}\] |
579594

580595
#### Output
581596

@@ -586,7 +601,7 @@ Create a new list in Attio
586601
| `name` | string | The list name |
587602
| `parentObject` | string | The parent object slug \(e.g. people, companies\) |
588603
| `workspaceAccess` | string | Workspace-level access \(e.g. full-access, read-only\) |
589-
| `workspaceMemberAccess` | string | Member-level default access |
604+
| `workspaceMemberAccess` | json | Member-level access entries |
590605
| `createdByActor` | object | The actor who created the list |
591606
| ↳ `type` | string | The actor type \(e.g. workspace-member, api-token, system\) |
592607
| ↳ `id` | string | The actor ID |
@@ -603,8 +618,8 @@ Update a list in Attio
603618
| `list` | string | Yes | The list ID or slug to update |
604619
| `name` | string | No | New name for the list |
605620
| `apiSlug` | string | No | New API slug for the list |
606-
| `workspaceAccess` | string | No | New workspace-level access: full-access, read-and-write, read-only, or none |
607-
| `workspaceMemberAccess` | string | No | New member access: full-access, read-and-write, read-only, or none |
621+
| `workspaceAccess` | string | No | New workspace-level access: full-access, read-and-write, or read-only \(omit for private\) |
622+
| `workspaceMemberAccess` | string | No | JSON array of member access entries, e.g. \[\{"workspace_member_id":"...","level":"read-and-write"\}\] |
608623

609624
#### Output
610625

@@ -615,7 +630,7 @@ Update a list in Attio
615630
| `name` | string | The list name |
616631
| `parentObject` | string | The parent object slug \(e.g. people, companies\) |
617632
| `workspaceAccess` | string | Workspace-level access \(e.g. full-access, read-only\) |
618-
| `workspaceMemberAccess` | string | Member-level default access |
633+
| `workspaceMemberAccess` | json | Member-level access entries |
619634
| `createdByActor` | object | The actor who created the list |
620635
| ↳ `type` | string | The actor type \(e.g. workspace-member, api-token, system\) |
621636
| ↳ `id` | string | The actor ID |
@@ -913,23 +928,8 @@ Get a single comment thread by ID from Attio
913928
| --------- | ---- | ----------- |
914929
| `threadId` | string | The thread ID |
915930
| `comments` | array | Comments in the thread |
916-
| ↳ `commentId` | string | The comment ID |
917-
| ↳ `threadId` | string | The thread ID |
918-
| ↳ `contentPlaintext` | string | The comment content as plaintext |
919-
| ↳ `author` | object | The comment author |
920-
| ↳ `type` | string | The actor type \(e.g. workspace-member, api-token, system\) |
921-
| ↳ `id` | string | The actor ID |
922-
| ↳ `entry` | object | The list entry this comment is on |
923-
| ↳ `listId` | string | The list ID |
924-
| ↳ `entryId` | string | The entry ID |
925-
| ↳ `record` | object | The record this comment is on |
926-
| ↳ `objectId` | string | The object ID |
927-
| ↳ `recordId` | string | The record ID |
928-
| ↳ `resolvedAt` | string | When the thread was resolved |
929-
| ↳ `resolvedBy` | object | Who resolved the thread |
930-
| ↳ `type` | string | The actor type \(e.g. workspace-member, api-token, system\) |
931-
| ↳ `id` | string | The actor ID |
932-
| ↳ `createdAt` | string | When the comment was created |
931+
| ↳ `type` | string | The actor type \(e.g. workspace-member, api-token, system\) |
932+
| ↳ `id` | string | The actor ID |
933933
| `createdAt` | string | When the thread was created |
934934

935935
### `attio_list_webhooks`
@@ -953,7 +953,7 @@ List all webhooks in the Attio workspace
953953
| ↳ `subscriptions` | array | Event subscriptions |
954954
| ↳ `eventType` | string | The event type \(e.g. record.created\) |
955955
| ↳ `filter` | json | Optional event filter |
956-
| ↳ `status` | string | Webhook status \(active, inactive\) |
956+
| ↳ `status` | string | Webhook status \(active, degraded, inactive\) |
957957
| ↳ `createdAt` | string | When the webhook was created |
958958
| `count` | number | Number of webhooks returned |
959959

@@ -976,7 +976,7 @@ Get a single webhook by ID from Attio
976976
| `subscriptions` | array | Event subscriptions |
977977
| ↳ `eventType` | string | The event type \(e.g. record.created\) |
978978
| ↳ `filter` | json | Optional event filter |
979-
| `status` | string | Webhook status \(active, inactive\) |
979+
| `status` | string | Webhook status \(active, degraded, inactive\) |
980980
| `createdAt` | string | When the webhook was created |
981981

982982
### `attio_create_webhook`
@@ -999,7 +999,7 @@ Create a webhook in Attio to receive event notifications
999999
| `subscriptions` | array | Event subscriptions |
10001000
| ↳ `eventType` | string | The event type \(e.g. record.created\) |
10011001
| ↳ `filter` | json | Optional event filter |
1002-
| `status` | string | Webhook status \(active, inactive\) |
1002+
| `status` | string | Webhook status \(active, degraded, inactive\) |
10031003
| `createdAt` | string | When the webhook was created |
10041004
| `secret` | string | The webhook signing secret \(only returned on creation\) |
10051005

@@ -1024,7 +1024,7 @@ Update a webhook in Attio (target URL and/or subscriptions)
10241024
| `subscriptions` | array | Event subscriptions |
10251025
| ↳ `eventType` | string | The event type \(e.g. record.created\) |
10261026
| ↳ `filter` | json | Optional event filter |
1027-
| `status` | string | Webhook status \(active, inactive\) |
1027+
| `status` | string | Webhook status \(active, degraded, inactive\) |
10281028
| `createdAt` | string | When the webhook was created |
10291029

10301030
### `attio_delete_webhook`

0 commit comments

Comments
 (0)