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

View Source

Summary

Functions

open(dialog, trigger_id, optional_params \\ %{})

Open a dialog with a user

API reference

Rate limit: Tier 4: 100+ per minute
Scopes: No scopes required

View on docs.slack.dev ↗

Required Params

  • dialog - The dialog definition. This must be a JSON-encoded string.
  • trigger_id - Exchange a trigger to post to the user. ex: 12345.98765.abcd2358fdea

Errors the API can return:

  • app_missing_action_url - The app associated with the used token doesn't have a Action URL configured in its interactive components settings.
  • cannot_create_dialog - Something exceptional occurred and the dialog could not be created.
  • failed_sending_dialog - Something exceptional occurred and the dialog could not be sent.
  • invalid_trigger - The provided trigger_id is invalid or cannot be used by this token.
  • missing_dialog - No dialog argument was presented.
  • missing_trigger - No trigger_id argument was presented.
  • trigger_exchanged - The provided trigger_id has already been exchanged.
  • trigger_expired - The provided trigger_id was presented after the 3 second limit.
  • validation_errors - The provided dialog could not be validated.

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