Agenda Shortcuts and Reference

A quick intro to App Shortcuts

App Shortcuts are ways to quickly get one or more tasks done in Agenda through the Shortcuts app. By combining multiple Agenda Shortcuts, optionally with those from other apps you can create and automate your workflows. From the simple opening of a specific note from the Home Screen of your iPad, triggering a new note after a double-tap on the back of your phone, to complex workflows that grab all the things you need to do today from different apps and creates a new project in one tap. It’s all possible using Shortcuts, and they’re not only available through the Shortcuts app, but also using Siri and Spotlight.

You find the list of Agenda shortcuts if you tap the plus button in the Shortcuts app, then select Apps and tap Agenda in the list of apps.

Tip: Read and learn more about Shortcuts and how to use the Shortcuts app in Apple’s Shortcuts User Guide

Overview Shortcuts

Open Overview

  • Shows an Overview in Agenda, selecting it in the sidebar
    Parameters
  • parameter: Overview
    Result
  • result parameter: Overview (opens the overview in Agenda)

Category Shortcuts

Add New Category

  • Adds a new project category, optionally as subcategory of an existing category.
    Parameters
  • parameter: Title
  • parameter (optional): Parent Category
    Result
  • result parameter: Category (holds the newly created Category)

Project Shortcuts

Find Project

  • Finds one or more projects based on the filter criteria provided (or all projects if no criteria are provided). Optionally limited to a certain number of projects.
    Parameters
  • parameter (optional): Title
  • parameter (optional): Is Archived
  • parameter (optional): Category
    Sort options
  • parameter (optional): Title
    Result
  • result parameter: Projects (holds the found Projects)

Open Project

  • Shows a project in Agenda, selecting it in the sidebar
    Parameters
  • parameter: Note
    Result
  • result parameter: Project (opens the project in Agenda)

Add New Project

  • Adds a new project to the category of choice, or to Other Projects if none is provided.
    Parameters
  • parameter: Title
  • parameter: Category
    Result
  • result parameter: Project (holds the newly created Project)
  • result action (optional): open the project in Agenda

Note Shortcuts

Find Note

  • Finds one or more notes based on the filter criteria provided (or all notes if no criteria are provided). Optionally limited to a certain number of notes.
    Parameters
  • parameter (optional): Title
  • parameter (optional): Project
    Sort options
  • parameter (optional): Title
    Result
  • result parameter: Notes (holds the found Notes)

Open Note

  • Shows a note in Agenda, selecting its project in the sidebar
    Parameters
  • parameter: Note
    Result
  • result parameter: Note (opens the note in Agenda)

Add New Note

  • Adds a new note to the project of choice.
    Parameters
  • parameter: Title
  • parameter: Project
    Result
  • result parameter: Note (holds the newly created Note)
  • result action (optional): open the note in Agenda

Append to Note

  • Adds text to the end of the provided note.
    Parameters
  • parameter: Text
  • parameter: Note
    Result
  • result parameter: Note (holds the edited Note)
  • result action (optional): open the note in Agenda

Get Note Text

  • Returns the text of the provided note as Rich Text.
    Parameters
  • parameter: Note
  • parameter (optional): Include Heading (whether the text should also include the title and date of the note)
    Result
  • result parameter: Text (holds the rich text of the Note)

Get Note Markdown

  • Returns the text of the provided note in markdown format.
    Parameters
  • parameter: Note
    Result
  • result parameter: Text (holds the text of the Note in markdown format)

Combining Shortcuts and x-callback URLs

Agenda also supports a set of x-callback URLs that can be used to automate Agenda. For a complete overview of the supported actions, see the X-callback-url Support and Reference topic. You can use these callbacks also from the Shortcuts app, for example if certain actions are not available through an App Shortcut, you can use an x-callback URL using a URL shortcut like shown here:

Notice that if your variables contain special characters, in this case the content of the clipboard, we first run it through a “URL encode” Shortcut to ensure the resulting x-callback URL is valid.

Tip: For some great examples of how to use x-callback URLs in the Shortcuts app, see how fellow community member @heyscottyj has created a number of daily logging Shortcuts for Agenda that he made available on his website.

Example use cases

2 Likes

I can’t wait to see MacOS version :wink:

1 Like

It should be part of macOS 13 Ventura when it ships in October

I was trying to set up a shortcuts workflow where I searched for a note using the Find Note shortcut, and passed the result into Get Note Text to extract the body of the note. Each time I called the Get Note Text shortcut though, I was prompted with a list and had to manually select the note I wanted to extract the text from.

Is this the intended behavior for the Get Note Text shortcut? I made sure only one note was being retrieved.

No that’s not intended, unfortunately that seems to be a bug in the current implementation, it’s like what you describe in iOS 16 but in the 16.1 beta it seems to now work as it should, so hopefully resolved soon. There’s still the issue where feeding a project from Find Project as filter criteria into Find Note doesn’t work either, also not get in the 16.1 beta. I’ve filed a bug with Apple for this one.