Slack.Web.Functions (SlackKit v1.0.0-alpha.0)

View Source

Summary

Functions

complete_error(error, function_execution_id, optional_params \\ %{})

Signal that a function failed to complete

API reference

Rate limit: Tier 3: 50+ per minute
Scopes: No scopes required

View on docs.slack.dev ↗

Required Params

  • error - A human-readable error message that contains information about why the function failed to complete
  • function_execution_id - Context identifier that maps to the executed function ex: Fx12345ABCDE

Errors the API can return:

  • execution_not_in_running_state - The function execution is no longer in a state to be completed.
  • function_execution_not_found - The specified function execution cannot be found.
  • unknown_method - This method does not exist.

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

complete_success(function_execution_id, outputs, optional_params \\ %{})

Signal the successful completion of a function

API reference

Rate limit: Tier 3: 50+ per minute
Scopes: No scopes required

View on docs.slack.dev ↗

Required Params

  • function_execution_id - Context identifier that maps to the executed function ex: Fx12345ABCDE
  • outputs - A JSON-based object that conforms to the output parameters schema for the custom function defined in the manifest ex: {"customer_id": "U0BPQUNTA"}

Errors the API can return:

  • execution_not_in_running_state - The function execution is no longer in a state to be completed.
  • function_execution_not_found - The specified function execution cannot be found.
  • parameter_validation_failed - There were problems when validating the outputs against the Function parameters. See API response for more details.
  • unknown_method - This method does not exist.

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