Multi-Actions

To support multiple actions, Action provider GET responses may include additional action URLs via the links attribute. Here's an example of what that might look like:

And here's the code supporting these use cases (NOTE: that this code defines ActionGetResponse, where the links attribute lives, as well as a LinkedAction interface):

export interface ActionGetResponse {
  /** url of some descriptive image for the action */
  icon: string;
  /** title of the action */
  title: string;
  /** brief description of the action */
  description: string;
  /** text to be rendered on the action button */
  label: string;
  /** optional state for disabling the action button(s) */
  disabled?: boolean;
  /** optional list of related Actions */
  links?: {
    actions: LinkedAction[];
  };
  /** optional (non-fatal) error message */
  error?: ActionError;
}

export interface LinkedAction {
  /** URL endpoint for an action */
  href: string;
  /** button text rendered to the user */
  label: string;
  /** Parameter to accept user input within an action */
  parameters?: [ActionParameter];
}

/** Parameter to accept user input within an action */
export interface ActionParameter {
  /** parameter name in url */
  name: string;
  /** placeholder text for the user input field */
  label?: string;
  /** declare if this field is required (defaults to `false`) */
  required?: boolean;
}

Linked Actions only provide a label and href , as they are intended to be used to display additional buttons in a single Blink. This interface affords you several options:

• Single inputs and one button

• Multiple inputs and one button

• Multiple inputs and multiple buttons

Consult those links for much more information, including code snippets you can lift for your own project. We also cover some of this in the next section.

A few other things to keep in mind:

• Linked actions hrefs support both absolute and relative paths.

• The optional parameters attribute allows for a second action type, which is covered in the next section.

• Linked actions are themselves Action URLs at href, and may themselves also return multiple actions.

Continue on the next section to read more about Action Types.