Slack. Web. Admin. Workflows
(SlackKit v1.0.0-alpha.0)
View Source
Summary
Functions
Search workflows within the team or enterprise
Unpublish workflows within the team or enterprise
Functions
Search workflows within the team or enterprise
API reference
Rate limit: Tier 2: 20+ per minute
Scopes:
- User token:
admin.workflows:read
Optional Params
app_id- The parent app ID for which to return workflows ex:A12345collaborator_ids- Only include workflows where all of the provided user IDs are a manager/collaborator of that workflowcursor- Setcursortonext_cursorreturned by the previous call to list items in the next page ex:dXNlcjpVMDYxTkZUVDI=is_sales_elevate- Filter workflows by their Sales Elevate statuslimit- The number of results that will be returned by the API on each invocation ex:20no_collaborators- Only include workflows with no collaborators in the result; default is falsenum_trigger_ids- Number of trigger IDs to fetch for each workflow; default is 10publish_status- Filter workflows by their published statusquery- A search query to filter for workflow name or description ex:Time offsort- The field used to sort the returned workflowssort_dir- Sort direction. Possible values areascfor ascending order like (1, 2, 3) or (a, b, c), anddescfor descending order like (3, 2, 1) or (c, b, a)source- Source of workflow creation, either from code or workflow builder Acceptable values:codeworkflow_buildersales_homeagentstep_function_ids- Only include workflows that use all of the provided step function idstrigger_type_id- Only include workflows with this trigger type
Errors the API can return:
invalid_cursor- Value passed forcursorwas not valid or is no longer valid.not_allowed- The user is not allowed to access this API method.
See the Common Errors guide for errors returned by every Web API method.
Unpublish workflows within the team or enterprise
API reference
Rate limit: Tier 2: 20+ per minute
Scopes:
- User token:
admin.workflows:write
Required Params
workflow_ids- Array of workflow IDs to unpublish
Errors the API can return:
error_unpublishing_workflows- There were one or more errors unpublishing workflowsnot_allowed- The user is not allowed to access this API method
See the Common Errors guide for errors returned by every Web API method.