Skip to content
  • Documentation >
  • Apps >
  • File and Document Management >
  • Shortcuts

Shortcuts

The Shortcuts module enables you to execute the scenario from your iPhone or iPad and send the desired data to Ibexa Connect.

Getting Started With Shortcuts

Prerequisites

  • iPhone or iPad with iOS 12 (or higher)

  • Shortcuts app

Connecting Shortcuts to Ibexa Connect

To connect Shortcuts to Ibexa Connect, you need to generate a webhook URL in Ibexa Connect and then insert the generated webhook URL to the Shortcuts app installed on your iOS device. To do so, follow the steps below:

Step 1: Download and install Shortcuts from App Store.

Step 2: Select an action you want to send data from.

Step 3: Add the Watch Shortcuts module to the scenario, and generate the webhook URL.

Step 4: Insert the webhook URL to Shortcuts.

Step 5: Specify the payload that will be sent to your Ibexa Connect scenario.

Step 6: Test your Shortcuts app integration.

Step 1: Download and Install Shortcuts From App Store

From your iPhone or iPad, navigate to https://apps.apple.com/us/app/shortcuts/id915249334, and install the Shortcuts app.

61f2799698963.png

Step 2: Select an Action You Want To Send Data From

  1. Open the Shortcuts app (61f27997a7106.png) you have installed in step 1 above.

  2. Tap the +Create Shortcut tile.

    61f27998c9d4e.png

  3. Add the action you want to send data to your scenario from.

Note

You can skip this step if you just want to trigger your scenario without any data being sent.

Here are some examples of actions you can use to send data to the Ibexa Connect scenario:

Note

We will use the Get Current Weather action as an example, but you can choose one or more other actions.

Get Current Weather - to send the current weather to your Ibexa Connect scenario.

61f2799b87c04.gif

Get Current Location - to send the device's address to your Ibexa Connect scenario.

Dictate Text - to trigger the Ibexa Connect scenario with your voice and send the speech converted to text to the scenario.

Ask for Input - to trigger the scenario and send the text, number, URL, or date you enter on your iOS device to your Ibexa Connect scenario.

Get Latest Photos - to send information about the latest photo on your device.

Contacts - to send the selected contact to your Ibexa Connect scenario.

Get Clipboard - to send the content of your clipboard to the Ibexa Connect scenario.

Step 3: Add the Shortcuts Module to the Scenario and Generate the Webhook URL

  1. Add the Watch Shortcuts module to your Ibexa Connect scenario.

  2. Generate and copy the webhook URL.

    61f2799e2550d.gif

Step 4: Insert the Webhook URL to Shortcuts

  1. Add the URL action to the Shortcut.

  2. Paste the webhook URL you have generated in Step 3 above.

    Note

Step 5: Specify the Payload That Will Be Sent to Your Ibexa Connect Scenario

  1. Add the Get Contents of URL action to the Shortcut.

    61f279a309e60.gif

  2. Tap to open the Get Contents of URL action's Advanced settings, and set it as follows:

    Method

    POST

    Headers

    No headers required.

    Request Body

    JSON

    Add new field

    Tap Add new field, and select the Text value type.

    Enter the desired name to the Key field, and tap, for example, the Weather Conditions (61f279a5e489f.png) in order to insert it into the Value field (or select another property you want to send to Ibexa Connect).Add more fields if needed.Tap Done.

    61f279a6e3177.gif

Step 6: Test Your Shortcuts Integration

  1. To test if the data from your iOS device is received correctly, go to your scenario, and run the Watch Shortcuts module only using the Run this module only function.

    61f279a9cc85b.gif

  2. Open the Shortcuts app on your iPhone or iPad, and tap the tile of the Shortcut to run actions you have defined in the steps above.

    61f279abb54a2.gif

  3. The Watch Shortcuts module in your scenario is triggered and receives the data from the Shortcut.

    61f279ae4c07f.png

You can now connect other modules to build your Ibexa Connect scenario. go to your scenario, and run the Watch Shortcuts module only using the Run this module only function.

61f279a9cc85b.gif

  1. Open the Shortcuts app on your iPhone or iPad, and tap the tile of the Shortcut to run actions you have defined in the steps above.

    61f279abb54a2.gif

  2. The Watch Shortcuts module in your scenario is triggered and receives the data from the Shortcut.

    61f279ae4c07f.png

You can now connect other modules to build your Ibexa Connect scenario.