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(optional_params \\ %{})

Search workflows within the team or enterprise

API reference

Rate limit: Tier 2: 20+ per minute
Scopes:

View on docs.slack.dev ↗

Optional Params

  • app_id - The parent app ID for which to return workflows ex: A12345
  • collaborator_ids - Only include workflows where all of the provided user IDs are a manager/collaborator of that workflow
  • cursor - Set cursor to next_cursor returned by the previous call to list items in the next page ex: dXNlcjpVMDYxTkZUVDI=
  • is_sales_elevate - Filter workflows by their Sales Elevate status
  • limit - The number of results that will be returned by the API on each invocation ex: 20
  • no_collaborators - Only include workflows with no collaborators in the result; default is false
  • num_trigger_ids - Number of trigger IDs to fetch for each workflow; default is 10
  • publish_status - Filter workflows by their published status
  • query - A search query to filter for workflow name or description ex: Time off
  • sort - The field used to sort the returned workflows
  • sort_dir - Sort direction. Possible values are asc for ascending order like (1, 2, 3) or (a, b, c), and desc for descending order like (3, 2, 1) or (c, b, a)
  • source - Source of workflow creation, either from code or workflow builder Acceptable values: code workflow_builder sales_home agent
  • step_function_ids - Only include workflows that use all of the provided step function ids
  • trigger_type_id - Only include workflows with this trigger type

Errors the API can return:

  • invalid_cursor - Value passed for cursor was 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(workflow_ids, optional_params \\ %{})

Unpublish workflows within the team or enterprise

API reference

Rate limit: Tier 2: 20+ per minute
Scopes:

View on docs.slack.dev ↗

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 workflows
  • 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.