Slack.Web.Workflows.Featured (SlackKit v1.0.0-alpha.0)

View Source

Summary

Functions

Add featured workflows to a channel.

List the featured workflows for specified channels.

Remove featured workflows from a channel.

Set featured workflows for a channel.

Functions

add(channel_id, trigger_ids, optional_params \\ %{})

Add featured workflows to a channel.

API reference

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

View on docs.slack.dev ↗

Required Params

  • channel_id - Channel to add featured workflow in.
  • trigger_ids - Comma-separated array of trigger IDs to add; max 15 ex: ["Ft012345", "Ft012346"]

Errors the API can return:

  • error_modifying_workflows - Error modifying workflows
  • method_not_supported - Method not yet supported
  • restricted_action - User does not have access to this method.

See the Common Errors guide for errors returned by every Web API method.

list(channel_ids, optional_params \\ %{})

List the featured workflows for specified channels.

API reference

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

View on docs.slack.dev ↗

Required Params

  • channel_ids - Comma-separated array of channel IDs to list featured workflows for. ex: ["C012345678", "C987654321"]

Errors the API can return:

  • channel_not_found - Channel not found.
  • error_invalid_channels - Invalid channels provided.
  • method_not_supported - Method not yet supported
  • restricted_action - User does not have access to this method.

See the Common Errors guide for errors returned by every Web API method.

remove(channel_id, trigger_ids, optional_params \\ %{})

Remove featured workflows from a channel.

API reference

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

View on docs.slack.dev ↗

Required Params

  • channel_id - Channel to remove featured workflow from.
  • trigger_ids - Comma-separated array of trigger IDs to remove; max 15 ex: ["Ft012345", "Ft012346"]

Errors the API can return:

  • error_modifying_workflows - Error modifying workflows
  • method_not_supported - Method not yet supported
  • restricted_action - User does not have access to this method.

See the Common Errors guide for errors returned by every Web API method.

set(channel_id, trigger_ids, optional_params \\ %{})

Set featured workflows for a channel.

API reference

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

View on docs.slack.dev ↗

Required Params

  • channel_id - Channel to set featured workflows in.
  • trigger_ids - Comma-separated array of trigger IDs that will replace any existing featured workflows in the channel; max 15 ex: ["Ft012345", "Ft012346"]

Errors the API can return:

  • error_modifying_workflows - Error modifying workflows
  • method_not_supported - Method not yet supported
  • restricted_action - User does not have access to this method.

See the Common Errors guide for errors returned by every Web API method.