@bitrix24/mcp-docs 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/__tests__/methods.test.d.ts +1 -0
- package/dist/__tests__/methods.test.js +54 -0
- package/dist/__tests__/methods.test.js.map +1 -0
- package/dist/__tests__/placements.test.d.ts +1 -0
- package/dist/__tests__/placements.test.js +36 -0
- package/dist/__tests__/placements.test.js.map +1 -0
- package/dist/__tests__/references.test.d.ts +1 -0
- package/dist/__tests__/references.test.js +42 -0
- package/dist/__tests__/references.test.js.map +1 -0
- package/dist/__tests__/scopes.test.d.ts +1 -0
- package/dist/__tests__/scopes.test.js +32 -0
- package/dist/__tests__/scopes.test.js.map +1 -0
- package/dist/__tests__/search.test.d.ts +1 -0
- package/dist/__tests__/search.test.js +43 -0
- package/dist/__tests__/search.test.js.map +1 -0
- package/dist/data/app-types.json +64 -0
- package/dist/data/categories.json +32 -0
- package/dist/data/methods.json +370 -0
- package/dist/data/placements.json +252 -0
- package/dist/data/scopes.json +177 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +77 -0
- package/dist/index.js.map +1 -0
- package/dist/resources/guides.d.ts +6 -0
- package/dist/resources/guides.js +26 -0
- package/dist/resources/guides.js.map +1 -0
- package/dist/tools/methods.d.ts +33 -0
- package/dist/tools/methods.js +24 -0
- package/dist/tools/methods.js.map +1 -0
- package/dist/tools/placements.d.ts +29 -0
- package/dist/tools/placements.js +18 -0
- package/dist/tools/placements.js.map +1 -0
- package/dist/tools/references.d.ts +12 -0
- package/dist/tools/references.js +9 -0
- package/dist/tools/references.js.map +1 -0
- package/dist/tools/scopes.d.ts +15 -0
- package/dist/tools/scopes.js +12 -0
- package/dist/tools/scopes.js.map +1 -0
- package/dist/tools/search.d.ts +18 -0
- package/dist/tools/search.js +47 -0
- package/dist/tools/search.js.map +1 -0
- package/package.json +35 -0
|
@@ -0,0 +1,370 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"method": "crm.deal.list",
|
|
4
|
+
"description": "Returns a paginated list of CRM deals matching the given filter. Supports filtering by any deal field, field selection, sorting, and pagination via start parameter.",
|
|
5
|
+
"scope": "crm",
|
|
6
|
+
"parameters": [
|
|
7
|
+
{ "name": "filter", "type": "object", "description": "Filter object. Keys are field names (prefix with > for greater-than, < for less-than). Example: { '>OPPORTUNITY': 1000, 'STAGE_ID': 'WON' }" },
|
|
8
|
+
{ "name": "select", "type": "array", "description": "Array of field names to return. Omit to return all fields. Example: ['ID', 'TITLE', 'OPPORTUNITY', 'STAGE_ID']" },
|
|
9
|
+
{ "name": "order", "type": "object", "description": "Sort order. Keys are field names, values are 'ASC' or 'DESC'. Example: { 'DATE_CREATE': 'DESC' }" },
|
|
10
|
+
{ "name": "start", "type": "number", "description": "Pagination offset. Use the 'next' value from the previous response. Default: 0" }
|
|
11
|
+
],
|
|
12
|
+
"returns": "Object with 'result' array of deal objects and 'total' count. Each deal contains ID, TITLE, OPPORTUNITY, CURRENCY_ID, STAGE_ID, ASSIGNED_BY_ID, DATE_CREATE, etc.",
|
|
13
|
+
"example": "BX24.callMethod('crm.deal.list', { filter: { '>OPPORTUNITY': 1000, 'ASSIGNED_BY_ID': 1 }, select: ['ID', 'TITLE', 'OPPORTUNITY', 'STAGE_ID'], order: { 'DATE_CREATE': 'DESC' }, start: 0 })"
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
"method": "crm.deal.get",
|
|
17
|
+
"description": "Returns full details of a single CRM deal by its ID, including all standard and custom fields.",
|
|
18
|
+
"scope": "crm",
|
|
19
|
+
"parameters": [
|
|
20
|
+
{ "name": "id", "type": "number", "description": "ID of the deal to retrieve" }
|
|
21
|
+
],
|
|
22
|
+
"returns": "Object with 'result' containing a single deal object with all fields including custom UF_ fields.",
|
|
23
|
+
"example": "BX24.callMethod('crm.deal.get', { id: 123 })"
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
"method": "crm.deal.add",
|
|
27
|
+
"description": "Creates a new CRM deal with the provided field values. Returns the ID of the newly created deal.",
|
|
28
|
+
"scope": "crm",
|
|
29
|
+
"parameters": [
|
|
30
|
+
{ "name": "fields", "type": "object", "description": "Object of field name-value pairs for the new deal. Required: TITLE. Common: OPPORTUNITY, CURRENCY_ID, STAGE_ID, CONTACT_ID, COMPANY_ID, ASSIGNED_BY_ID" }
|
|
31
|
+
],
|
|
32
|
+
"returns": "Object with 'result' containing the integer ID of the newly created deal.",
|
|
33
|
+
"example": "BX24.callMethod('crm.deal.add', { fields: { TITLE: 'New Deal', OPPORTUNITY: 50000, CURRENCY_ID: 'USD', STAGE_ID: 'NEW', ASSIGNED_BY_ID: 1 } })"
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"method": "crm.deal.update",
|
|
37
|
+
"description": "Updates field values on an existing CRM deal. Only provided fields are changed; omitted fields retain their current values.",
|
|
38
|
+
"scope": "crm",
|
|
39
|
+
"parameters": [
|
|
40
|
+
{ "name": "id", "type": "number", "description": "ID of the deal to update" },
|
|
41
|
+
{ "name": "fields", "type": "object", "description": "Object of field name-value pairs to update on the deal" }
|
|
42
|
+
],
|
|
43
|
+
"returns": "Object with 'result' = true on success.",
|
|
44
|
+
"example": "BX24.callMethod('crm.deal.update', { id: 123, fields: { STAGE_ID: 'WON', OPPORTUNITY: 75000 } })"
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
"method": "crm.deal.delete",
|
|
48
|
+
"description": "Permanently deletes a CRM deal by its ID. This action is irreversible.",
|
|
49
|
+
"scope": "crm",
|
|
50
|
+
"parameters": [
|
|
51
|
+
{ "name": "id", "type": "number", "description": "ID of the deal to delete" }
|
|
52
|
+
],
|
|
53
|
+
"returns": "Object with 'result' = true on success.",
|
|
54
|
+
"example": "BX24.callMethod('crm.deal.delete', { id: 123 })"
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
"method": "crm.lead.list",
|
|
58
|
+
"description": "Returns a paginated list of CRM leads matching the given filter. Supports filtering, field selection, sorting, and pagination.",
|
|
59
|
+
"scope": "crm",
|
|
60
|
+
"parameters": [
|
|
61
|
+
{ "name": "filter", "type": "object", "description": "Filter object for lead fields. Example: { 'STATUS_ID': 'NEW', '>DATE_CREATE': '2024-01-01' }" },
|
|
62
|
+
{ "name": "select", "type": "array", "description": "Array of field names to return. Example: ['ID', 'TITLE', 'NAME', 'LAST_NAME', 'STATUS_ID', 'ASSIGNED_BY_ID']" },
|
|
63
|
+
{ "name": "order", "type": "object", "description": "Sort order object. Example: { 'DATE_CREATE': 'DESC' }" },
|
|
64
|
+
{ "name": "start", "type": "number", "description": "Pagination offset." }
|
|
65
|
+
],
|
|
66
|
+
"returns": "Object with 'result' array of lead objects and 'total' count.",
|
|
67
|
+
"example": "BX24.callMethod('crm.lead.list', { filter: { 'STATUS_ID': 'NEW' }, select: ['ID', 'TITLE', 'NAME', 'LAST_NAME', 'PHONE'], order: { 'DATE_CREATE': 'DESC' } })"
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"method": "crm.lead.add",
|
|
71
|
+
"description": "Creates a new CRM lead with the provided field values.",
|
|
72
|
+
"scope": "crm",
|
|
73
|
+
"parameters": [
|
|
74
|
+
{ "name": "fields", "type": "object", "description": "Object of field name-value pairs. Required: TITLE (or NAME/LAST_NAME). Common: PHONE, EMAIL, STATUS_ID, SOURCE_ID, ASSIGNED_BY_ID" }
|
|
75
|
+
],
|
|
76
|
+
"returns": "Object with 'result' containing the integer ID of the newly created lead.",
|
|
77
|
+
"example": "BX24.callMethod('crm.lead.add', { fields: { TITLE: 'New Lead', NAME: 'John', LAST_NAME: 'Doe', PHONE: [{ VALUE: '+1234567890', VALUE_TYPE: 'WORK' }], STATUS_ID: 'NEW' } })"
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"method": "crm.contact.list",
|
|
81
|
+
"description": "Returns a paginated list of CRM contacts matching the given filter.",
|
|
82
|
+
"scope": "crm",
|
|
83
|
+
"parameters": [
|
|
84
|
+
{ "name": "filter", "type": "object", "description": "Filter object for contact fields. Example: { 'COMPANY_ID': 456 }" },
|
|
85
|
+
{ "name": "select", "type": "array", "description": "Array of field names to return." },
|
|
86
|
+
{ "name": "order", "type": "object", "description": "Sort order object." },
|
|
87
|
+
{ "name": "start", "type": "number", "description": "Pagination offset." }
|
|
88
|
+
],
|
|
89
|
+
"returns": "Object with 'result' array of contact objects and 'total' count.",
|
|
90
|
+
"example": "BX24.callMethod('crm.contact.list', { filter: { 'COMPANY_ID': 456 }, select: ['ID', 'NAME', 'LAST_NAME', 'PHONE', 'EMAIL'] })"
|
|
91
|
+
},
|
|
92
|
+
{
|
|
93
|
+
"method": "crm.contact.add",
|
|
94
|
+
"description": "Creates a new CRM contact with the provided field values.",
|
|
95
|
+
"scope": "crm",
|
|
96
|
+
"parameters": [
|
|
97
|
+
{ "name": "fields", "type": "object", "description": "Object of field name-value pairs. Common: NAME, LAST_NAME, PHONE, EMAIL, COMPANY_ID, ASSIGNED_BY_ID" }
|
|
98
|
+
],
|
|
99
|
+
"returns": "Object with 'result' containing the integer ID of the newly created contact.",
|
|
100
|
+
"example": "BX24.callMethod('crm.contact.add', { fields: { NAME: 'Jane', LAST_NAME: 'Smith', EMAIL: [{ VALUE: 'jane@example.com', VALUE_TYPE: 'WORK' }], COMPANY_ID: 456 } })"
|
|
101
|
+
},
|
|
102
|
+
{
|
|
103
|
+
"method": "crm.company.list",
|
|
104
|
+
"description": "Returns a paginated list of CRM companies matching the given filter.",
|
|
105
|
+
"scope": "crm",
|
|
106
|
+
"parameters": [
|
|
107
|
+
{ "name": "filter", "type": "object", "description": "Filter object for company fields. Example: { '%TITLE': 'Acme' }" },
|
|
108
|
+
{ "name": "select", "type": "array", "description": "Array of field names to return." },
|
|
109
|
+
{ "name": "order", "type": "object", "description": "Sort order object." },
|
|
110
|
+
{ "name": "start", "type": "number", "description": "Pagination offset." }
|
|
111
|
+
],
|
|
112
|
+
"returns": "Object with 'result' array of company objects and 'total' count.",
|
|
113
|
+
"example": "BX24.callMethod('crm.company.list', { filter: { '%TITLE': 'Acme' }, select: ['ID', 'TITLE', 'PHONE', 'EMAIL', 'INDUSTRY'] })"
|
|
114
|
+
},
|
|
115
|
+
{
|
|
116
|
+
"method": "crm.company.add",
|
|
117
|
+
"description": "Creates a new CRM company with the provided field values.",
|
|
118
|
+
"scope": "crm",
|
|
119
|
+
"parameters": [
|
|
120
|
+
{ "name": "fields", "type": "object", "description": "Object of field name-value pairs. Required: TITLE. Common: PHONE, EMAIL, INDUSTRY, ASSIGNED_BY_ID" }
|
|
121
|
+
],
|
|
122
|
+
"returns": "Object with 'result' containing the integer ID of the newly created company.",
|
|
123
|
+
"example": "BX24.callMethod('crm.company.add', { fields: { TITLE: 'Acme Corp', INDUSTRY: 'IT', PHONE: [{ VALUE: '+1234567890', VALUE_TYPE: 'WORK' }] } })"
|
|
124
|
+
},
|
|
125
|
+
{
|
|
126
|
+
"method": "crm.deal.fields",
|
|
127
|
+
"description": "Returns the list of all available fields for the CRM Deal entity, including standard fields and custom UF_ fields with their types, captions, and attributes.",
|
|
128
|
+
"scope": "crm",
|
|
129
|
+
"parameters": [],
|
|
130
|
+
"returns": "Object with 'result' containing a map of field codes to field descriptor objects including type, title, isRequired, isReadOnly, isMultiple.",
|
|
131
|
+
"example": "BX24.callMethod('crm.deal.fields')"
|
|
132
|
+
},
|
|
133
|
+
{
|
|
134
|
+
"method": "tasks.task.list",
|
|
135
|
+
"description": "Returns a paginated list of tasks visible to the current user, with filtering, field selection, and sorting support.",
|
|
136
|
+
"scope": "task",
|
|
137
|
+
"parameters": [
|
|
138
|
+
{ "name": "filter", "type": "object", "description": "Filter object. Supports fields like RESPONSIBLE_ID, GROUP_ID, STATUS, DEADLINE. Example: { 'RESPONSIBLE_ID': 1, 'STATUS': 2 }" },
|
|
139
|
+
{ "name": "select", "type": "array", "description": "Array of field names. Example: ['ID', 'TITLE', 'DESCRIPTION', 'STATUS', 'RESPONSIBLE_ID', 'DEADLINE']" },
|
|
140
|
+
{ "name": "order", "type": "object", "description": "Sort order. Example: { 'DEADLINE': 'ASC' }" },
|
|
141
|
+
{ "name": "start", "type": "number", "description": "Pagination offset." }
|
|
142
|
+
],
|
|
143
|
+
"returns": "Object with 'result.tasks' array of task objects and 'result.total' count.",
|
|
144
|
+
"example": "BX24.callMethod('tasks.task.list', { filter: { 'RESPONSIBLE_ID': 1, '!STATUS': 5 }, select: ['ID', 'TITLE', 'STATUS', 'DEADLINE'], order: { 'DEADLINE': 'ASC' } })"
|
|
145
|
+
},
|
|
146
|
+
{
|
|
147
|
+
"method": "tasks.task.get",
|
|
148
|
+
"description": "Returns full details of a single task by its ID.",
|
|
149
|
+
"scope": "task",
|
|
150
|
+
"parameters": [
|
|
151
|
+
{ "name": "taskId", "type": "number", "description": "ID of the task to retrieve" },
|
|
152
|
+
{ "name": "select", "type": "array", "description": "Optional array of field names to return" }
|
|
153
|
+
],
|
|
154
|
+
"returns": "Object with 'result.task' containing the task data including all fields.",
|
|
155
|
+
"example": "BX24.callMethod('tasks.task.get', { taskId: 42 })"
|
|
156
|
+
},
|
|
157
|
+
{
|
|
158
|
+
"method": "tasks.task.add",
|
|
159
|
+
"description": "Creates a new task with the provided field values.",
|
|
160
|
+
"scope": "task",
|
|
161
|
+
"parameters": [
|
|
162
|
+
{ "name": "fields", "type": "object", "description": "Task fields. Required: TITLE. Common: DESCRIPTION, RESPONSIBLE_ID, DEADLINE, GROUP_ID, PARENT_ID, PRIORITY" }
|
|
163
|
+
],
|
|
164
|
+
"returns": "Object with 'result.task' containing the newly created task with its assigned ID.",
|
|
165
|
+
"example": "BX24.callMethod('tasks.task.add', { fields: { TITLE: 'Prepare report', RESPONSIBLE_ID: 5, DEADLINE: '2024-12-31T18:00:00+03:00', PRIORITY: 2 } })"
|
|
166
|
+
},
|
|
167
|
+
{
|
|
168
|
+
"method": "tasks.task.update",
|
|
169
|
+
"description": "Updates field values on an existing task. Only provided fields are changed.",
|
|
170
|
+
"scope": "task",
|
|
171
|
+
"parameters": [
|
|
172
|
+
{ "name": "taskId", "type": "number", "description": "ID of the task to update" },
|
|
173
|
+
{ "name": "fields", "type": "object", "description": "Object of field name-value pairs to update" }
|
|
174
|
+
],
|
|
175
|
+
"returns": "Object with 'result' = true on success.",
|
|
176
|
+
"example": "BX24.callMethod('tasks.task.update', { taskId: 42, fields: { STATUS: 5, DEADLINE: '2024-12-15T18:00:00+03:00' } })"
|
|
177
|
+
},
|
|
178
|
+
{
|
|
179
|
+
"method": "tasks.task.complete",
|
|
180
|
+
"description": "Marks a task as completed.",
|
|
181
|
+
"scope": "task",
|
|
182
|
+
"parameters": [
|
|
183
|
+
{ "name": "taskId", "type": "number", "description": "ID of the task to complete" }
|
|
184
|
+
],
|
|
185
|
+
"returns": "Object with 'result' = true on success.",
|
|
186
|
+
"example": "BX24.callMethod('tasks.task.complete', { taskId: 42 })"
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
"method": "im.message.add",
|
|
190
|
+
"description": "Sends a message to a Bitrix24 chat or to a specific user. Supports text, system messages, and rich content attachments.",
|
|
191
|
+
"scope": "im",
|
|
192
|
+
"parameters": [
|
|
193
|
+
{ "name": "DIALOG_ID", "type": "string", "description": "Target dialog ID. Use 'userId' format (e.g. '1') for private messages or chat ID for group chats." },
|
|
194
|
+
{ "name": "MESSAGE", "type": "string", "description": "Text content of the message. Supports BBCode formatting." },
|
|
195
|
+
{ "name": "SYSTEM", "type": "string", "description": "Set to 'Y' to send as a system notification (no sender name displayed). Default: 'N'" },
|
|
196
|
+
{ "name": "ATTACH", "type": "object", "description": "Optional rich attachment object with blocks (image, link, table, etc.)" }
|
|
197
|
+
],
|
|
198
|
+
"returns": "Object with 'result' containing the integer ID of the sent message.",
|
|
199
|
+
"example": "BX24.callMethod('im.message.add', { DIALOG_ID: '1', MESSAGE: 'Hello! Your deal has been updated.', SYSTEM: 'N' })"
|
|
200
|
+
},
|
|
201
|
+
{
|
|
202
|
+
"method": "im.chat.get",
|
|
203
|
+
"description": "Returns information about a specific chat by its ID.",
|
|
204
|
+
"scope": "im",
|
|
205
|
+
"parameters": [
|
|
206
|
+
{ "name": "CHAT_ID", "type": "number", "description": "ID of the chat to retrieve" }
|
|
207
|
+
],
|
|
208
|
+
"returns": "Object with 'result' containing chat details: name, type, owner, member count, etc.",
|
|
209
|
+
"example": "BX24.callMethod('im.chat.get', { CHAT_ID: 100 })"
|
|
210
|
+
},
|
|
211
|
+
{
|
|
212
|
+
"method": "im.chat.add",
|
|
213
|
+
"description": "Creates a new group chat with the specified members.",
|
|
214
|
+
"scope": "im",
|
|
215
|
+
"parameters": [
|
|
216
|
+
{ "name": "TITLE", "type": "string", "description": "Chat name" },
|
|
217
|
+
{ "name": "USERS", "type": "array", "description": "Array of user IDs to add to the chat" },
|
|
218
|
+
{ "name": "TYPE", "type": "string", "description": "Chat type: 'CHAT' for group chat, 'OPEN' for open channel. Default: 'CHAT'" }
|
|
219
|
+
],
|
|
220
|
+
"returns": "Object with 'result.CHAT_ID' containing the ID of the newly created chat.",
|
|
221
|
+
"example": "BX24.callMethod('im.chat.add', { TITLE: 'Project Alpha', USERS: [1, 5, 12], TYPE: 'CHAT' })"
|
|
222
|
+
},
|
|
223
|
+
{
|
|
224
|
+
"method": "disk.folder.uploadfile",
|
|
225
|
+
"description": "Uploads a file to a specified folder in Bitrix24 Drive.",
|
|
226
|
+
"scope": "disk",
|
|
227
|
+
"parameters": [
|
|
228
|
+
{ "name": "id", "type": "number", "description": "ID of the target folder in Bitrix24 Drive" },
|
|
229
|
+
{ "name": "data", "type": "object", "description": "File data object with 'NAME' (filename) and 'CONTENT' (base64-encoded file content)" },
|
|
230
|
+
{ "name": "rights", "type": "array", "description": "Optional access rights for the uploaded file" }
|
|
231
|
+
],
|
|
232
|
+
"returns": "Object with 'result' containing the created file object with ID, NAME, SIZE, DOWNLOAD_URL, etc.",
|
|
233
|
+
"example": "BX24.callMethod('disk.folder.uploadfile', { id: 10, data: { NAME: 'report.pdf', CONTENT: '<base64 content>' } })"
|
|
234
|
+
},
|
|
235
|
+
{
|
|
236
|
+
"method": "disk.folder.getchildren",
|
|
237
|
+
"description": "Returns the list of files and subfolders within a specified folder.",
|
|
238
|
+
"scope": "disk",
|
|
239
|
+
"parameters": [
|
|
240
|
+
{ "name": "id", "type": "number", "description": "ID of the folder to list" },
|
|
241
|
+
{ "name": "filter", "type": "object", "description": "Optional filter. Example: { 'TYPE': 'file' }" },
|
|
242
|
+
{ "name": "start", "type": "number", "description": "Pagination offset." }
|
|
243
|
+
],
|
|
244
|
+
"returns": "Object with 'result' array of file and folder objects with their metadata.",
|
|
245
|
+
"example": "BX24.callMethod('disk.folder.getchildren', { id: 10 })"
|
|
246
|
+
},
|
|
247
|
+
{
|
|
248
|
+
"method": "disk.file.get",
|
|
249
|
+
"description": "Returns metadata and download URL for a specific file in Bitrix24 Drive.",
|
|
250
|
+
"scope": "disk",
|
|
251
|
+
"parameters": [
|
|
252
|
+
{ "name": "id", "type": "number", "description": "ID of the file to retrieve" }
|
|
253
|
+
],
|
|
254
|
+
"returns": "Object with 'result' containing file metadata: NAME, SIZE, MIME_TYPE, DOWNLOAD_URL, CREATE_TIME, UPDATE_TIME, etc.",
|
|
255
|
+
"example": "BX24.callMethod('disk.file.get', { id: 250 })"
|
|
256
|
+
},
|
|
257
|
+
{
|
|
258
|
+
"method": "disk.file.delete",
|
|
259
|
+
"description": "Moves a file to the Bitrix24 Drive trash (does not permanently delete).",
|
|
260
|
+
"scope": "disk",
|
|
261
|
+
"parameters": [
|
|
262
|
+
{ "name": "id", "type": "number", "description": "ID of the file to move to trash" }
|
|
263
|
+
],
|
|
264
|
+
"returns": "Object with 'result' = true on success.",
|
|
265
|
+
"example": "BX24.callMethod('disk.file.delete', { id: 250 })"
|
|
266
|
+
},
|
|
267
|
+
{
|
|
268
|
+
"method": "disk.storage.getlist",
|
|
269
|
+
"description": "Returns the list of storages (drives) available to the current application or user.",
|
|
270
|
+
"scope": "disk",
|
|
271
|
+
"parameters": [],
|
|
272
|
+
"returns": "Object with 'result' array of storage objects with ID, NAME, MODULE_ID, ENTITY_TYPE, ROOT_OBJECT_ID.",
|
|
273
|
+
"example": "BX24.callMethod('disk.storage.getlist')"
|
|
274
|
+
},
|
|
275
|
+
{
|
|
276
|
+
"method": "user.get",
|
|
277
|
+
"description": "Returns a list of users matching the given filter. Commonly used to search for users by name, email, or department.",
|
|
278
|
+
"scope": "user",
|
|
279
|
+
"parameters": [
|
|
280
|
+
{ "name": "FILTER", "type": "object", "description": "Filter object. Supports: ID, NAME, LAST_NAME, EMAIL, DEPARTMENT_ID, USER_TYPE. Example: { 'DEPARTMENT_ID': 3, 'ACTIVE': true }" },
|
|
281
|
+
{ "name": "SELECT", "type": "array", "description": "Array of field names to return. Example: ['ID', 'NAME', 'LAST_NAME', 'EMAIL', 'PERSONAL_PHOTO']" },
|
|
282
|
+
{ "name": "START", "type": "number", "description": "Pagination offset." }
|
|
283
|
+
],
|
|
284
|
+
"returns": "Object with 'result' array of user objects with all requested fields.",
|
|
285
|
+
"example": "BX24.callMethod('user.get', { FILTER: { 'DEPARTMENT_ID': 3, 'ACTIVE': true }, SELECT: ['ID', 'NAME', 'LAST_NAME', 'EMAIL', 'WORK_POSITION'] })"
|
|
286
|
+
},
|
|
287
|
+
{
|
|
288
|
+
"method": "user.current",
|
|
289
|
+
"description": "Returns the profile of the currently authenticated user (the user whose access token is being used). Useful for identifying who is interacting with your application.",
|
|
290
|
+
"scope": "user_basic",
|
|
291
|
+
"parameters": [],
|
|
292
|
+
"returns": "Object with 'result' containing the current user's profile: ID, NAME, LAST_NAME, EMAIL, PERSONAL_PHOTO, WORK_POSITION, IS_ADMIN, etc.",
|
|
293
|
+
"example": "BX24.callMethod('user.current')"
|
|
294
|
+
},
|
|
295
|
+
{
|
|
296
|
+
"method": "user.update",
|
|
297
|
+
"description": "Updates profile fields for a specified user.",
|
|
298
|
+
"scope": "user",
|
|
299
|
+
"parameters": [
|
|
300
|
+
{ "name": "ID", "type": "number", "description": "ID of the user to update" },
|
|
301
|
+
{ "name": "FIELDS", "type": "object", "description": "Object of field name-value pairs to update. Example: { 'WORK_POSITION': 'Senior Developer' }" }
|
|
302
|
+
],
|
|
303
|
+
"returns": "Object with 'result' = true on success.",
|
|
304
|
+
"example": "BX24.callMethod('user.update', { ID: 5, FIELDS: { WORK_POSITION: 'Senior Developer', WORK_PHONE: '+1234567890' } })"
|
|
305
|
+
},
|
|
306
|
+
{
|
|
307
|
+
"method": "placement.bind",
|
|
308
|
+
"description": "Registers an application handler URL for a specific Bitrix24 UI placement. This is how applications add custom buttons, tabs, and menu items to the Bitrix24 interface.",
|
|
309
|
+
"scope": "placement",
|
|
310
|
+
"parameters": [
|
|
311
|
+
{ "name": "PLACEMENT", "type": "string", "description": "The placement code to bind to. Example: 'CRM_DEAL_DETAIL_TAB'" },
|
|
312
|
+
{ "name": "HANDLER", "type": "string", "description": "The full HTTPS URL of your handler that will be loaded in the placement" },
|
|
313
|
+
{ "name": "TITLE", "type": "string", "description": "Display title for the placement (button label, tab name, menu item text)" },
|
|
314
|
+
{ "name": "DESCRIPTION", "type": "string", "description": "Optional description of the placement" },
|
|
315
|
+
{ "name": "OPTIONS", "type": "object", "description": "Optional placement-specific options. For tabs: { label: 'Tab Name' }" }
|
|
316
|
+
],
|
|
317
|
+
"returns": "Object with 'result' = true on success.",
|
|
318
|
+
"example": "BX24.callMethod('placement.bind', { PLACEMENT: 'CRM_DEAL_DETAIL_TAB', HANDLER: 'https://myapp.example.com/deal-tab', TITLE: 'Integration', OPTIONS: { label: 'My Integration' } })"
|
|
319
|
+
},
|
|
320
|
+
{
|
|
321
|
+
"method": "placement.list",
|
|
322
|
+
"description": "Returns all placements currently bound by the current application.",
|
|
323
|
+
"scope": "placement",
|
|
324
|
+
"parameters": [],
|
|
325
|
+
"returns": "Object with 'result' array of bound placement objects with PLACEMENT, HANDLER, TITLE, and OPTIONS.",
|
|
326
|
+
"example": "BX24.callMethod('placement.list')"
|
|
327
|
+
},
|
|
328
|
+
{
|
|
329
|
+
"method": "placement.unbind",
|
|
330
|
+
"description": "Removes a previously registered handler for a specific placement.",
|
|
331
|
+
"scope": "placement",
|
|
332
|
+
"parameters": [
|
|
333
|
+
{ "name": "PLACEMENT", "type": "string", "description": "The placement code to unbind" },
|
|
334
|
+
{ "name": "HANDLER", "type": "string", "description": "The handler URL to remove" }
|
|
335
|
+
],
|
|
336
|
+
"returns": "Object with 'result' containing the count of removed bindings.",
|
|
337
|
+
"example": "BX24.callMethod('placement.unbind', { PLACEMENT: 'CRM_DEAL_DETAIL_TAB', HANDLER: 'https://myapp.example.com/deal-tab' })"
|
|
338
|
+
},
|
|
339
|
+
{
|
|
340
|
+
"method": "app.info",
|
|
341
|
+
"description": "Returns information about the current application installation: application code, scope, portal domain, member ID, and current user details.",
|
|
342
|
+
"scope": "main",
|
|
343
|
+
"parameters": [],
|
|
344
|
+
"returns": "Object with 'result' containing: ID (app code), STATUS, INSTALL, PAYMENT_EXPIRED, DAYS, LICENSE, PORTAL_ADDRESS, MEMBER_ID, USER_ID, IS_ADMIN, PLACED, SCOPE.",
|
|
345
|
+
"example": "BX24.callMethod('app.info')"
|
|
346
|
+
},
|
|
347
|
+
{
|
|
348
|
+
"method": "event.bind",
|
|
349
|
+
"description": "Subscribes the application to a Bitrix24 server event. When the event occurs, Bitrix24 will send an HTTP POST to the handler URL.",
|
|
350
|
+
"scope": "main",
|
|
351
|
+
"parameters": [
|
|
352
|
+
{ "name": "EVENT", "type": "string", "description": "Event name to subscribe to. Example: 'ONCRMDEALADD', 'ONCRMDEALUPDATE'" },
|
|
353
|
+
{ "name": "HANDLER", "type": "string", "description": "Full HTTPS URL that will receive event notifications" },
|
|
354
|
+
{ "name": "AUTH_TYPE", "type": "number", "description": "User ID to use for auth token sent with events. Default: 0 (application token)" }
|
|
355
|
+
],
|
|
356
|
+
"returns": "Object with 'result' = true on success.",
|
|
357
|
+
"example": "BX24.callMethod('event.bind', { EVENT: 'ONCRMDEALADD', HANDLER: 'https://myapp.example.com/webhook/deal-added' })"
|
|
358
|
+
},
|
|
359
|
+
{
|
|
360
|
+
"method": "event.unbind",
|
|
361
|
+
"description": "Removes a previously registered event subscription.",
|
|
362
|
+
"scope": "main",
|
|
363
|
+
"parameters": [
|
|
364
|
+
{ "name": "EVENT", "type": "string", "description": "Event name to unsubscribe from" },
|
|
365
|
+
{ "name": "HANDLER", "type": "string", "description": "Handler URL to remove" }
|
|
366
|
+
],
|
|
367
|
+
"returns": "Object with 'result' = true on success.",
|
|
368
|
+
"example": "BX24.callMethod('event.unbind', { EVENT: 'ONCRMDEALADD', HANDLER: 'https://myapp.example.com/webhook/deal-added' })"
|
|
369
|
+
}
|
|
370
|
+
]
|
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
[
|
|
2
|
+
{
|
|
3
|
+
"code": "CRM_LEAD_LIST_MENU",
|
|
4
|
+
"title": "Lead list context menu",
|
|
5
|
+
"description": "Adds a custom menu item to the context menu in the CRM Leads list. The handler is called when the user right-clicks or opens the action menu on a lead row.",
|
|
6
|
+
"module": "crm",
|
|
7
|
+
"group": "CRM Lists",
|
|
8
|
+
"handler_params": [
|
|
9
|
+
{ "name": "PLACEMENT", "type": "string", "description": "Placement code: CRM_LEAD_LIST_MENU" },
|
|
10
|
+
{ "name": "ID", "type": "number", "description": "ID of the lead" }
|
|
11
|
+
],
|
|
12
|
+
"example": "BX24.callMethod('placement.bind', { PLACEMENT: 'CRM_LEAD_LIST_MENU', HANDLER: 'https://myapp.example.com/handler', TITLE: 'My Action' })"
|
|
13
|
+
},
|
|
14
|
+
{
|
|
15
|
+
"code": "CRM_CONTACT_LIST_MENU",
|
|
16
|
+
"title": "Contact list context menu",
|
|
17
|
+
"description": "Adds a custom menu item to the context menu in the CRM Contacts list. The handler is called when the user opens the action menu on a contact row.",
|
|
18
|
+
"module": "crm",
|
|
19
|
+
"group": "CRM Lists",
|
|
20
|
+
"handler_params": [
|
|
21
|
+
{ "name": "PLACEMENT", "type": "string", "description": "Placement code: CRM_CONTACT_LIST_MENU" },
|
|
22
|
+
{ "name": "ID", "type": "number", "description": "ID of the contact" }
|
|
23
|
+
],
|
|
24
|
+
"example": "BX24.callMethod('placement.bind', { PLACEMENT: 'CRM_CONTACT_LIST_MENU', HANDLER: 'https://myapp.example.com/handler', TITLE: 'My Action' })"
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
"code": "CRM_COMPANY_LIST_MENU",
|
|
28
|
+
"title": "Company list context menu",
|
|
29
|
+
"description": "Adds a custom menu item to the context menu in the CRM Companies list. The handler is called when the user opens the action menu on a company row.",
|
|
30
|
+
"module": "crm",
|
|
31
|
+
"group": "CRM Lists",
|
|
32
|
+
"handler_params": [
|
|
33
|
+
{ "name": "PLACEMENT", "type": "string", "description": "Placement code: CRM_COMPANY_LIST_MENU" },
|
|
34
|
+
{ "name": "ID", "type": "number", "description": "ID of the company" }
|
|
35
|
+
],
|
|
36
|
+
"example": "BX24.callMethod('placement.bind', { PLACEMENT: 'CRM_COMPANY_LIST_MENU', HANDLER: 'https://myapp.example.com/handler', TITLE: 'My Action' })"
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"code": "CRM_DEAL_LIST_MENU",
|
|
40
|
+
"title": "Deal list context menu",
|
|
41
|
+
"description": "Adds a custom menu item to the context menu in the CRM Deals list. The handler is called when the user opens the action menu on a deal row.",
|
|
42
|
+
"module": "crm",
|
|
43
|
+
"group": "CRM Lists",
|
|
44
|
+
"handler_params": [
|
|
45
|
+
{ "name": "PLACEMENT", "type": "string", "description": "Placement code: CRM_DEAL_LIST_MENU" },
|
|
46
|
+
{ "name": "ID", "type": "number", "description": "ID of the deal" }
|
|
47
|
+
],
|
|
48
|
+
"example": "BX24.callMethod('placement.bind', { PLACEMENT: 'CRM_DEAL_LIST_MENU', HANDLER: 'https://myapp.example.com/handler', TITLE: 'My Action' })"
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"code": "CRM_QUOTE_LIST_MENU",
|
|
52
|
+
"title": "Quote list context menu",
|
|
53
|
+
"description": "Adds a custom menu item to the context menu in the CRM Quotes (Estimates) list. The handler is called when the user opens the action menu on a quote row.",
|
|
54
|
+
"module": "crm",
|
|
55
|
+
"group": "CRM Lists",
|
|
56
|
+
"handler_params": [
|
|
57
|
+
{ "name": "PLACEMENT", "type": "string", "description": "Placement code: CRM_QUOTE_LIST_MENU" },
|
|
58
|
+
{ "name": "ID", "type": "number", "description": "ID of the quote" }
|
|
59
|
+
],
|
|
60
|
+
"example": "BX24.callMethod('placement.bind', { PLACEMENT: 'CRM_QUOTE_LIST_MENU', HANDLER: 'https://myapp.example.com/handler', TITLE: 'My Action' })"
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
"code": "CRM_SMART_INVOICE_LIST_MENU",
|
|
64
|
+
"title": "Smart invoice list context menu",
|
|
65
|
+
"description": "Adds a custom menu item to the context menu in the CRM Smart Invoices list. The handler is called when the user opens the action menu on a smart invoice row.",
|
|
66
|
+
"module": "crm",
|
|
67
|
+
"group": "CRM Lists",
|
|
68
|
+
"handler_params": [
|
|
69
|
+
{ "name": "PLACEMENT", "type": "string", "description": "Placement code: CRM_SMART_INVOICE_LIST_MENU" },
|
|
70
|
+
{ "name": "ID", "type": "number", "description": "ID of the smart invoice" }
|
|
71
|
+
],
|
|
72
|
+
"example": "BX24.callMethod('placement.bind', { PLACEMENT: 'CRM_SMART_INVOICE_LIST_MENU', HANDLER: 'https://myapp.example.com/handler', TITLE: 'My Action' })"
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
"code": "CRM_LEAD_DETAIL_TAB",
|
|
76
|
+
"title": "Lead detail tab",
|
|
77
|
+
"description": "Embeds a custom tab (iframe) into the CRM Lead detail page. Your application is displayed inside the tab when the user opens a lead record. Useful for showing related data, third-party integrations, or custom widgets alongside the lead.",
|
|
78
|
+
"module": "crm",
|
|
79
|
+
"group": "CRM Detail Tabs",
|
|
80
|
+
"handler_params": [
|
|
81
|
+
{ "name": "PLACEMENT", "type": "string", "description": "Placement code: CRM_LEAD_DETAIL_TAB" },
|
|
82
|
+
{ "name": "ID", "type": "number", "description": "ID of the lead being viewed" }
|
|
83
|
+
],
|
|
84
|
+
"example": "BX24.callMethod('placement.bind', { PLACEMENT: 'CRM_LEAD_DETAIL_TAB', HANDLER: 'https://myapp.example.com/tab', TITLE: 'My Tab', OPTIONS: { label: 'My Tab' } })"
|
|
85
|
+
},
|
|
86
|
+
{
|
|
87
|
+
"code": "CRM_DEAL_DETAIL_TAB",
|
|
88
|
+
"title": "Deal detail tab",
|
|
89
|
+
"description": "Embeds a custom tab (iframe) into the CRM Deal detail page. Your application is displayed inside the tab when the user opens a deal record. Useful for showing related data, external documents, or custom analytics alongside the deal.",
|
|
90
|
+
"module": "crm",
|
|
91
|
+
"group": "CRM Detail Tabs",
|
|
92
|
+
"handler_params": [
|
|
93
|
+
{ "name": "PLACEMENT", "type": "string", "description": "Placement code: CRM_DEAL_DETAIL_TAB" },
|
|
94
|
+
{ "name": "ID", "type": "number", "description": "ID of the deal being viewed" }
|
|
95
|
+
],
|
|
96
|
+
"example": "BX24.callMethod('placement.bind', { PLACEMENT: 'CRM_DEAL_DETAIL_TAB', HANDLER: 'https://myapp.example.com/tab', TITLE: 'My Tab', OPTIONS: { label: 'My Tab' } })"
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
"code": "CRM_CONTACT_DETAIL_TAB",
|
|
100
|
+
"title": "Contact detail tab",
|
|
101
|
+
"description": "Embeds a custom tab (iframe) into the CRM Contact detail page. Your application is displayed inside the tab when the user opens a contact record.",
|
|
102
|
+
"module": "crm",
|
|
103
|
+
"group": "CRM Detail Tabs",
|
|
104
|
+
"handler_params": [
|
|
105
|
+
{ "name": "PLACEMENT", "type": "string", "description": "Placement code: CRM_CONTACT_DETAIL_TAB" },
|
|
106
|
+
{ "name": "ID", "type": "number", "description": "ID of the contact being viewed" }
|
|
107
|
+
],
|
|
108
|
+
"example": "BX24.callMethod('placement.bind', { PLACEMENT: 'CRM_CONTACT_DETAIL_TAB', HANDLER: 'https://myapp.example.com/tab', TITLE: 'My Tab', OPTIONS: { label: 'My Tab' } })"
|
|
109
|
+
},
|
|
110
|
+
{
|
|
111
|
+
"code": "CRM_COMPANY_DETAIL_TAB",
|
|
112
|
+
"title": "Company detail tab",
|
|
113
|
+
"description": "Embeds a custom tab (iframe) into the CRM Company detail page. Your application is displayed inside the tab when the user opens a company record.",
|
|
114
|
+
"module": "crm",
|
|
115
|
+
"group": "CRM Detail Tabs",
|
|
116
|
+
"handler_params": [
|
|
117
|
+
{ "name": "PLACEMENT", "type": "string", "description": "Placement code: CRM_COMPANY_DETAIL_TAB" },
|
|
118
|
+
{ "name": "ID", "type": "number", "description": "ID of the company being viewed" }
|
|
119
|
+
],
|
|
120
|
+
"example": "BX24.callMethod('placement.bind', { PLACEMENT: 'CRM_COMPANY_DETAIL_TAB', HANDLER: 'https://myapp.example.com/tab', TITLE: 'My Tab', OPTIONS: { label: 'My Tab' } })"
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"code": "CRM_QUOTE_DETAIL_TAB",
|
|
124
|
+
"title": "Quote detail tab",
|
|
125
|
+
"description": "Embeds a custom tab (iframe) into the CRM Quote (Estimate) detail page. Your application is displayed inside the tab when the user opens a quote record.",
|
|
126
|
+
"module": "crm",
|
|
127
|
+
"group": "CRM Detail Tabs",
|
|
128
|
+
"handler_params": [
|
|
129
|
+
{ "name": "PLACEMENT", "type": "string", "description": "Placement code: CRM_QUOTE_DETAIL_TAB" },
|
|
130
|
+
{ "name": "ID", "type": "number", "description": "ID of the quote being viewed" }
|
|
131
|
+
],
|
|
132
|
+
"example": "BX24.callMethod('placement.bind', { PLACEMENT: 'CRM_QUOTE_DETAIL_TAB', HANDLER: 'https://myapp.example.com/tab', TITLE: 'My Tab', OPTIONS: { label: 'My Tab' } })"
|
|
133
|
+
},
|
|
134
|
+
{
|
|
135
|
+
"code": "CRM_SMART_INVOICE_DETAIL_TAB",
|
|
136
|
+
"title": "Smart invoice detail tab",
|
|
137
|
+
"description": "Embeds a custom tab (iframe) into the CRM Smart Invoice detail page. Your application is displayed inside the tab when the user opens a smart invoice record.",
|
|
138
|
+
"module": "crm",
|
|
139
|
+
"group": "CRM Detail Tabs",
|
|
140
|
+
"handler_params": [
|
|
141
|
+
{ "name": "PLACEMENT", "type": "string", "description": "Placement code: CRM_SMART_INVOICE_DETAIL_TAB" },
|
|
142
|
+
{ "name": "ID", "type": "number", "description": "ID of the smart invoice being viewed" }
|
|
143
|
+
],
|
|
144
|
+
"example": "BX24.callMethod('placement.bind', { PLACEMENT: 'CRM_SMART_INVOICE_DETAIL_TAB', HANDLER: 'https://myapp.example.com/tab', TITLE: 'My Tab', OPTIONS: { label: 'My Tab' } })"
|
|
145
|
+
},
|
|
146
|
+
{
|
|
147
|
+
"code": "CRM_LEAD_DETAIL_ACTIVITY",
|
|
148
|
+
"title": "Lead detail activity",
|
|
149
|
+
"description": "Adds a custom activity button in the CRM Lead detail page activity section. Allows applications to create custom activity types visible in the lead timeline and activity block.",
|
|
150
|
+
"module": "crm",
|
|
151
|
+
"group": "CRM Detail Activity",
|
|
152
|
+
"handler_params": [
|
|
153
|
+
{ "name": "PLACEMENT", "type": "string", "description": "Placement code: CRM_LEAD_DETAIL_ACTIVITY" },
|
|
154
|
+
{ "name": "ID", "type": "number", "description": "ID of the lead" }
|
|
155
|
+
],
|
|
156
|
+
"example": "BX24.callMethod('placement.bind', { PLACEMENT: 'CRM_LEAD_DETAIL_ACTIVITY', HANDLER: 'https://myapp.example.com/activity', TITLE: 'My Activity' })"
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
"code": "CRM_DEAL_DETAIL_ACTIVITY",
|
|
160
|
+
"title": "Deal detail activity",
|
|
161
|
+
"description": "Adds a custom activity button in the CRM Deal detail page activity section. Allows applications to create custom activity types visible in the deal timeline and activity block.",
|
|
162
|
+
"module": "crm",
|
|
163
|
+
"group": "CRM Detail Activity",
|
|
164
|
+
"handler_params": [
|
|
165
|
+
{ "name": "PLACEMENT", "type": "string", "description": "Placement code: CRM_DEAL_DETAIL_ACTIVITY" },
|
|
166
|
+
{ "name": "ID", "type": "number", "description": "ID of the deal" }
|
|
167
|
+
],
|
|
168
|
+
"example": "BX24.callMethod('placement.bind', { PLACEMENT: 'CRM_DEAL_DETAIL_ACTIVITY', HANDLER: 'https://myapp.example.com/activity', TITLE: 'My Activity' })"
|
|
169
|
+
},
|
|
170
|
+
{
|
|
171
|
+
"code": "CRM_CONTACT_DETAIL_ACTIVITY",
|
|
172
|
+
"title": "Contact detail activity",
|
|
173
|
+
"description": "Adds a custom activity button in the CRM Contact detail page activity section. Allows applications to create custom activity types visible in the contact timeline and activity block.",
|
|
174
|
+
"module": "crm",
|
|
175
|
+
"group": "CRM Detail Activity",
|
|
176
|
+
"handler_params": [
|
|
177
|
+
{ "name": "PLACEMENT", "type": "string", "description": "Placement code: CRM_CONTACT_DETAIL_ACTIVITY" },
|
|
178
|
+
{ "name": "ID", "type": "number", "description": "ID of the contact" }
|
|
179
|
+
],
|
|
180
|
+
"example": "BX24.callMethod('placement.bind', { PLACEMENT: 'CRM_CONTACT_DETAIL_ACTIVITY', HANDLER: 'https://myapp.example.com/activity', TITLE: 'My Activity' })"
|
|
181
|
+
},
|
|
182
|
+
{
|
|
183
|
+
"code": "CRM_COMPANY_DETAIL_ACTIVITY",
|
|
184
|
+
"title": "Company detail activity",
|
|
185
|
+
"description": "Adds a custom activity button in the CRM Company detail page activity section. Allows applications to create custom activity types visible in the company timeline and activity block.",
|
|
186
|
+
"module": "crm",
|
|
187
|
+
"group": "CRM Detail Activity",
|
|
188
|
+
"handler_params": [
|
|
189
|
+
{ "name": "PLACEMENT", "type": "string", "description": "Placement code: CRM_COMPANY_DETAIL_ACTIVITY" },
|
|
190
|
+
{ "name": "ID", "type": "number", "description": "ID of the company" }
|
|
191
|
+
],
|
|
192
|
+
"example": "BX24.callMethod('placement.bind', { PLACEMENT: 'CRM_COMPANY_DETAIL_ACTIVITY', HANDLER: 'https://myapp.example.com/activity', TITLE: 'My Activity' })"
|
|
193
|
+
},
|
|
194
|
+
{
|
|
195
|
+
"code": "TASK_LIST_CONTEXT_MENU",
|
|
196
|
+
"title": "Task list context menu",
|
|
197
|
+
"description": "Adds a custom menu item to the context menu in the Tasks list. The handler is called when the user right-clicks or opens the action menu on a task row. Useful for adding task-related actions from external systems.",
|
|
198
|
+
"module": "tasks",
|
|
199
|
+
"group": "Tasks",
|
|
200
|
+
"handler_params": [
|
|
201
|
+
{ "name": "PLACEMENT", "type": "string", "description": "Placement code: TASK_LIST_CONTEXT_MENU" },
|
|
202
|
+
{ "name": "ID", "type": "number", "description": "ID of the task" }
|
|
203
|
+
],
|
|
204
|
+
"example": "BX24.callMethod('placement.bind', { PLACEMENT: 'TASK_LIST_CONTEXT_MENU', HANDLER: 'https://myapp.example.com/task-action', TITLE: 'Export Task' })"
|
|
205
|
+
},
|
|
206
|
+
{
|
|
207
|
+
"code": "USER_PROFILE_MENU",
|
|
208
|
+
"title": "User profile menu",
|
|
209
|
+
"description": "Adds a custom menu item to the user profile action menu. The handler is called when the user opens the menu on any user profile page. Useful for profile-related integrations like HR systems.",
|
|
210
|
+
"module": "user",
|
|
211
|
+
"group": "User Profile",
|
|
212
|
+
"handler_params": [
|
|
213
|
+
{ "name": "PLACEMENT", "type": "string", "description": "Placement code: USER_PROFILE_MENU" },
|
|
214
|
+
{ "name": "USER_ID", "type": "number", "description": "ID of the user whose profile is being viewed" }
|
|
215
|
+
],
|
|
216
|
+
"example": "BX24.callMethod('placement.bind', { PLACEMENT: 'USER_PROFILE_MENU', HANDLER: 'https://myapp.example.com/user-action', TITLE: 'View HR Profile' })"
|
|
217
|
+
},
|
|
218
|
+
{
|
|
219
|
+
"code": "USER_PROFILE_TOOLBAR",
|
|
220
|
+
"title": "User profile toolbar",
|
|
221
|
+
"description": "Adds a custom button to the toolbar on user profile pages. The handler is called when the user clicks the button on any user profile. Useful for quick actions related to a user from external HR or directory systems.",
|
|
222
|
+
"module": "user",
|
|
223
|
+
"group": "User Profile",
|
|
224
|
+
"handler_params": [
|
|
225
|
+
{ "name": "PLACEMENT", "type": "string", "description": "Placement code: USER_PROFILE_TOOLBAR" },
|
|
226
|
+
{ "name": "USER_ID", "type": "number", "description": "ID of the user whose profile is being viewed" }
|
|
227
|
+
],
|
|
228
|
+
"example": "BX24.callMethod('placement.bind', { PLACEMENT: 'USER_PROFILE_TOOLBAR', HANDLER: 'https://myapp.example.com/user-toolbar', TITLE: 'My Action' })"
|
|
229
|
+
},
|
|
230
|
+
{
|
|
231
|
+
"code": "REST_APP_URI",
|
|
232
|
+
"title": "Application main page (universal)",
|
|
233
|
+
"description": "The primary entry point for an application embedded inside Bitrix24. The application is displayed as a full-page iframe accessible from the left navigation menu or from the app catalogue. This is the most common placement for general-purpose applications.",
|
|
234
|
+
"module": "main",
|
|
235
|
+
"group": "Universal",
|
|
236
|
+
"handler_params": [
|
|
237
|
+
{ "name": "PLACEMENT", "type": "string", "description": "Placement code: REST_APP_URI" }
|
|
238
|
+
],
|
|
239
|
+
"example": "BX24.callMethod('placement.bind', { PLACEMENT: 'REST_APP_URI', HANDLER: 'https://myapp.example.com/', TITLE: 'My App' })"
|
|
240
|
+
},
|
|
241
|
+
{
|
|
242
|
+
"code": "PAGE_BACKGROUND_WORKER",
|
|
243
|
+
"title": "Page background worker",
|
|
244
|
+
"description": "A hidden background iframe that runs on every Bitrix24 page. Useful for applications that need to listen to events, run periodic checks, or react to user navigation without being visible. The handler URL is loaded invisibly in the background.",
|
|
245
|
+
"module": "main",
|
|
246
|
+
"group": "Universal",
|
|
247
|
+
"handler_params": [
|
|
248
|
+
{ "name": "PLACEMENT", "type": "string", "description": "Placement code: PAGE_BACKGROUND_WORKER" }
|
|
249
|
+
],
|
|
250
|
+
"example": "BX24.callMethod('placement.bind', { PLACEMENT: 'PAGE_BACKGROUND_WORKER', HANDLER: 'https://myapp.example.com/worker' })"
|
|
251
|
+
}
|
|
252
|
+
]
|