Trigger object

Defines the trigger a workflow button points at, and the input parameters to start it with.


Used in	Workflow button element

Usage

A trigger object is used inside a workflow object, which is set on a workflow button.

Fields

Field	Type	Description	Required?
`url`	String	A link trigger URL. On Slack it must belong to a valid trigger.	Required
`customizable_input_parameters`	Object[]	An array of input parameter objects, each `{ "name": String, "value": String }`. On Slack each `name` must match a customizable input parameter of the trigger’s workflow. Values may be visible to readers — don’t put secrets in them.	Optional

Examples

A trigger with input parameters

{
  "blocks": [
    {
      "type": "section",
      "text": {
        "type": "mrkdwn",
        "text": "*Blue Harbor Logistics* asked for a renewal quote."
      },
      "accessory": {
        "type": "workflow_button",
        "text": {
          "type": "plain_text",
          "text": "Start renewal"
        },
        "action_id": "start_renewal",
        "workflow": {
          "trigger": {
            "url": "https://example.com/triggers/renewal-quote",
            "customizable_input_parameters": [
              {
                "name": "account",
                "value": "Blue Harbor Logistics"
              },
              {
                "name": "term_months",
                "value": "24"
              }
            ]
          }
        }
      }
    }
  ]
}