Skip to content

Commit e1a2c4d

Browse files
author
Slack API Ref Buildbot
committed
Updated from Slack docs, 2025/09/21
1 parent 5d988c5 commit e1a2c4d

File tree

148 files changed

+1276
-1184
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

148 files changed

+1276
-1184
lines changed

‎methods/admin/admin.analytics.getFile.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@
1010
"desc": "Date to retrieve the analytics data for, expressed as YYYY-MM-DD in UTC. Required unless metadata_only is set to true.",
1111
"type": "date"
1212
},
13-
"metadata_only": {
14-
"required": false,
15-
"example": "true",
16-
"desc": "Retrieve metadata for the type of analytics indicated. Can be used only with type set to public_channel analytics. See detail below. Omit the date parameter when using this argument.",
17-
"type": "boolean"
18-
},
1913
"type": {
2014
"required": true,
2115
"example": "member",
2216
"desc": "The type of analytics to retrieve. The options are currently limited to member (for Enterprise org member analytics) and public_channel (for public channel analytics).",
2317
"type": "string"
18+
},
19+
"metadata_only": {
20+
"required": false,
21+
"example": "true",
22+
"desc": "Retrieve metadata for the type of analytics indicated. Can be used only with type set to public_channel analytics. See detail below. Omit the date parameter when using this argument.",
23+
"type": "boolean"
2424
}
2525
},
2626
"response": {

‎methods/admin/admin.apps.activities.list.json‎

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,10 @@
99
"example": "A12345",
1010
"desc": "The ID of the app to get activities from."
1111
},
12-
"component_id": {
13-
"required": false,
14-
"example": "Wf013SMGL4V9",
15-
"desc": "The component ID of log events to be returned. Will be FnXXXXXX for functions, and WfXXXXXX for workflows.",
16-
"type": "string"
17-
},
18-
"component_type": {
12+
"team_id": {
1913
"required": false,
20-
"example": "workflows",
21-
"desc": "The component type of log events to be returned. Acceptable values are events_api, workflows, functions and tables.",
14+
"example": "T12345",
15+
"desc": "The team who owns this log.",
2216
"type": "string"
2317
},
2418
"cursor": {
@@ -33,53 +27,59 @@
3327
"desc": "The maximum number of items to return.",
3428
"type": "integer"
3529
},
36-
"log_event_type": {
37-
"required": false,
38-
"example": "test_log_event",
39-
"desc": "The event type of log events to be returned.",
40-
"type": "string"
41-
},
42-
"max_date_created": {
43-
"required": false,
44-
"example": "1646665572336299",
45-
"desc": "The latest timestamp of the log to retrieve (epoch microseconds).",
46-
"type": "integer"
47-
},
48-
"min_date_created": {
49-
"required": false,
50-
"example": "1646665572336251",
51-
"desc": "The earliest timestamp of the log to retrieve (epoch microseconds).",
52-
"type": "integer"
53-
},
5430
"min_log_level": {
5531
"required": false,
5632
"example": "info",
5733
"desc": "The minimum log level of the log events to be returned. Defaults to info. Acceptable values (in order of relative importance from smallest to largest) are trace, debug, info, warn, error and fatal.",
5834
"type": "string"
5935
},
60-
"sort_direction": {
36+
"log_event_type": {
6137
"required": false,
62-
"example": "asc",
63-
"desc": "The direction you want the data sorted by (always by timestamp).",
64-
"type": "enum"
38+
"example": "test_log_event",
39+
"desc": "The event type of log events to be returned.",
40+
"type": "string"
6541
},
6642
"source": {
6743
"required": false,
6844
"example": "slack",
6945
"desc": "The source of log events to be returned. Acceptable values are slack and developer.",
7046
"type": "string"
7147
},
72-
"team_id": {
48+
"component_type": {
7349
"required": false,
74-
"example": "T12345",
75-
"desc": "The team who owns this log.",
50+
"example": "workflows",
51+
"desc": "The component type of log events to be returned. Acceptable values are events_api, workflows, functions and tables.",
52+
"type": "string"
53+
},
54+
"component_id": {
55+
"required": false,
56+
"example": "Wf013SMGL4V9",
57+
"desc": "The component ID of log events to be returned. Will be FnXXXXXX for functions, and WfXXXXXX for workflows.",
7658
"type": "string"
7759
},
7860
"trace_id": {
7961
"required": false,
8062
"example": "Tr432f2",
8163
"desc": "The trace ID of log events to be returned.",
8264
"type": "string"
65+
},
66+
"min_date_created": {
67+
"required": false,
68+
"example": "1646665572336251",
69+
"desc": "The earliest timestamp of the log to retrieve (epoch microseconds).",
70+
"type": "integer"
71+
},
72+
"max_date_created": {
73+
"required": false,
74+
"example": "1646665572336299",
75+
"desc": "The latest timestamp of the log to retrieve (epoch microseconds).",
76+
"type": "integer"
77+
},
78+
"sort_direction": {
79+
"required": false,
80+
"example": "asc",
81+
"desc": "The direction you want the data sorted by (always by timestamp).",
82+
"type": "enum"
8383
}
8484
},
8585
"response": {

‎methods/admin/admin.apps.approve.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,6 @@
1010
"desc": "The id of the app to approve.",
1111
"type": "string"
1212
},
13-
"enterprise_id": {
14-
"required": false,
15-
"example": "E12345",
16-
"desc": "The ID of the enterprise to approve the app on."
17-
},
1813
"request_id": {
1914
"required": false,
2015
"example": "Ar12345",
@@ -25,6 +20,11 @@
2520
"required": false,
2621
"example": "T12345",
2722
"desc": "The ID of the workspace to approve the app on."
23+
},
24+
"enterprise_id": {
25+
"required": false,
26+
"example": "E12345",
27+
"desc": "The ID of the enterprise to approve the app on."
2828
}
2929
},
3030
"response": {

‎methods/admin/admin.apps.approved.list.json‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,33 @@
44
"deprecated": false,
55
"desc": "List approved apps for an org or workspace.",
66
"args": {
7-
"certified": {
7+
"limit": {
88
"required": false,
9-
"example": "false",
10-
"desc": "Limit the results to only include certified apps. When false, no certified apps will appear in the result.",
11-
"type": "boolean"
9+
"example": "100",
10+
"desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.",
11+
"type": "integer"
1212
},
1313
"cursor": {
1414
"required": false,
1515
"example": "5c3e53d5",
1616
"desc": "Set cursor to next_cursor returned by the previous call to list items in the next page.",
1717
"type": "string"
1818
},
19-
"enterprise_id": {
19+
"team_id": {
2020
"required": false,
21-
"example": "E0AS553RN",
21+
"example": "T0HFE6EBT",
2222
"desc": ""
2323
},
24-
"limit": {
24+
"enterprise_id": {
2525
"required": false,
26-
"example": "100",
27-
"desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.",
28-
"type": "integer"
26+
"example": "E0AS553RN",
27+
"desc": ""
2928
},
30-
"team_id": {
29+
"certified": {
3130
"required": false,
32-
"example": "T0HFE6EBT",
33-
"desc": ""
31+
"example": "false",
32+
"desc": "Limit the results to only include certified apps. When false, no certified apps will appear in the result.",
33+
"type": "boolean"
3434
}
3535
},
3636
"response": {

‎methods/admin/admin.apps.clearResolution.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@
1010
"desc": "The id of the app whose resolution you want to clear/undo.",
1111
"type": "string"
1212
},
13-
"enterprise_id": {
14-
"required": false,
15-
"example": "E12345",
16-
"desc": "The enterprise to clear the app resolution from."
17-
},
1813
"team_id": {
1914
"required": false,
2015
"example": "T12345",
2116
"desc": "The workspace to clear the app resolution from."
17+
},
18+
"enterprise_id": {
19+
"required": false,
20+
"example": "E12345",
21+
"desc": "The enterprise to clear the app resolution from."
2222
}
2323
},
2424
"response": {

‎methods/admin/admin.apps.config.set.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,20 @@
99
"example": "A12345",
1010
"desc": "The encoded app ID to set the app config for."
1111
},
12-
"domain_restrictions": {
12+
"workflow_auth_strategy": {
1313
"required": false,
14-
"desc": "Domain restrictions for the app. Should be an object with two properties: urls and emails. Each is an array of strings, and each sets the allowed URLs and emails for connector authorization, respectively.",
15-
"type": "object"
14+
"desc": "The workflow auth permission. Can be one of builder_choice or end_user_only.",
15+
"type": "enum"
1616
},
1717
"rich_link_preview_type": {
1818
"required": false,
1919
"desc": "Indicates the app-level override for rich link preview. Unsupported for free teams.",
2020
"type": "enum"
2121
},
22-
"workflow_auth_strategy": {
22+
"domain_restrictions": {
2323
"required": false,
24-
"desc": "The workflow auth permission. Can be one of builder_choice or end_user_only.",
25-
"type": "enum"
24+
"desc": "Domain restrictions for the app. Should be an object with two properties: urls and emails. Each is an array of strings, and each sets the allowed URLs and emails for connector authorization, respectively.",
25+
"type": "object"
2626
}
2727
},
2828
"response": {

‎methods/admin/admin.apps.requests.cancel.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,6 @@
44
"deprecated": false,
55
"desc": "Cancel app request for team",
66
"args": {
7-
"enterprise_id": {
8-
"required": false,
9-
"example": "E12345",
10-
"desc": "The ID of the enterprise where this request belongs."
11-
},
127
"request_id": {
138
"required": true,
149
"example": "Ar12345",
@@ -19,6 +14,11 @@
1914
"required": false,
2015
"example": "T12345",
2116
"desc": "The ID of the workspace where this request belongs."
17+
},
18+
"enterprise_id": {
19+
"required": false,
20+
"example": "E12345",
21+
"desc": "The ID of the enterprise where this request belongs."
2222
}
2323
},
2424
"response": {

‎methods/admin/admin.apps.requests.list.json‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,31 @@
44
"deprecated": false,
55
"desc": "List app requests for a team/workspace.",
66
"args": {
7-
"certified": {
7+
"limit": {
88
"required": false,
9-
"example": "false",
10-
"desc": "Include requests for certified apps.",
11-
"type": "boolean"
9+
"example": "100",
10+
"desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.",
11+
"type": "integer"
1212
},
1313
"cursor": {
1414
"required": false,
1515
"example": "5c3e53d5",
1616
"desc": "Set cursor to next_cursor returned by the previous call to list items in the next page.",
1717
"type": "string"
1818
},
19-
"enterprise_id": {
19+
"team_id": {
2020
"required": false,
2121
"desc": ""
2222
},
23-
"limit": {
23+
"enterprise_id": {
2424
"required": false,
25-
"example": "100",
26-
"desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.",
27-
"type": "integer"
25+
"desc": ""
2826
},
29-
"team_id": {
27+
"certified": {
3028
"required": false,
31-
"desc": ""
29+
"example": "false",
30+
"desc": "Include requests for certified apps.",
31+
"type": "boolean"
3232
}
3333
},
3434
"response": {

‎methods/admin/admin.apps.restrict.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,6 @@
1010
"desc": "The id of the app to restrict.",
1111
"type": "string"
1212
},
13-
"enterprise_id": {
14-
"required": false,
15-
"example": "E12345",
16-
"desc": "The ID of the enterprise to approve the app on."
17-
},
1813
"request_id": {
1914
"required": false,
2015
"example": "Ar12345",
@@ -25,6 +20,11 @@
2520
"required": false,
2621
"example": "T12345",
2722
"desc": "The ID of the workspace to approve the app on."
23+
},
24+
"enterprise_id": {
25+
"required": false,
26+
"example": "E12345",
27+
"desc": "The ID of the enterprise to approve the app on."
2828
}
2929
},
3030
"response": {

‎methods/admin/admin.apps.restricted.list.json‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,32 @@
44
"deprecated": false,
55
"desc": "List restricted apps for an org or workspace.",
66
"args": {
7-
"certified": {
7+
"limit": {
88
"required": false,
9-
"desc": "Limit the results to only include certified apps. When false, no certified apps will appear in the result.",
10-
"type": "boolean"
9+
"example": "100",
10+
"desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.",
11+
"type": "integer"
1112
},
1213
"cursor": {
1314
"required": false,
1415
"example": "5c3e53d5",
1516
"desc": "Set cursor to next_cursor returned by the previous call to list items in the next page.",
1617
"type": "string"
1718
},
18-
"enterprise_id": {
19+
"team_id": {
1920
"required": false,
20-
"example": "E0AS553RN",
21+
"example": "T0HFE6EBT",
2122
"desc": ""
2223
},
23-
"limit": {
24+
"enterprise_id": {
2425
"required": false,
25-
"example": "100",
26-
"desc": "The maximum number of items to return. Must be between 1 - 1000 both inclusive.",
27-
"type": "integer"
26+
"example": "E0AS553RN",
27+
"desc": ""
2828
},
29-
"team_id": {
29+
"certified": {
3030
"required": false,
31-
"example": "T0HFE6EBT",
32-
"desc": ""
31+
"desc": "Limit the results to only include certified apps. When false, no certified apps will appear in the result.",
32+
"type": "boolean"
3333
}
3434
},
3535
"response": {

0 commit comments

Comments
 (0)