Docs / Integration API contract

Interactive buttons

An app's buttons call its interactivity URL, which an administrator sets in Apps and integrations. Unlike on Slack, the URL must echo a url_verification challenge (see Events) before it is accepted, so this server cannot be aimed at an unrelated host.

A press posts a form with a payload field holding Slack's block_actions payload: team, user, api_app_id, channel, message (with ts, text and user), container, trigger_id, response_url, and one entry in actions with type: "button", action_id, block_id, text, value, style and action_ts.

The answer — immediately or through the response_url — is handled like a slash command's, plus:

  • "replace_original": true rewrites the message the button was on, and its buttons go with it;
  • "delete_original": true removes that message.

Both work through the response_url too, which is where Bolt's respond() sends them after acknowledging the press.

A button with an http(s) url opens the link in the person's browser and calls nothing. Only buttons are drawn from an actions block.

This page is made from docs/INTEGRATIONS.md.