Apple Shortcuts Integration Guide

Overview

Apple Shortcuts lets you build automations that run on iPhone, iPad, Mac, and Apple Watch. By connecting Orbyt's REST API, you can create Siri commands and home screen shortcuts that interact with your job pipeline.

Prerequisites

• Orbyt Ultra plan
• iPhone, iPad, or Mac with the Shortcuts app
• An Orbyt API key (generate one in Settings > Account > API Keys)

Step 1: Generate an API Key

1. Open Orbyt and go to Settings > Account
2. Scroll to API Keys
3. Click Create API Key
4. Name it "Apple Shortcuts" and select the appropriate permissions
5. Copy the token (starts with ext_)

Step 2: Create Your First Shortcut

Morning Pipeline Briefing

This shortcut gives you a spoken summary of your pipeline when you say "Hey Siri, pipeline briefing."

1. Open the Shortcuts app
2. Tap + to create a new shortcut
3. Add Get Contents of URL action:

- URL: https://www.orbytjobs.ai/api/mcp/pipeline

- Method: GET

- Headers: Add Authorization with value Bearer ext_your_token

1. Add Get Dictionary Value action:

- Key: summary

1. Add Speak Text action with a template like:

You have [total] jobs in your pipeline. [applied] applications sent, [interviewing] in interviews, and [offer] offers.

1. Name it "Pipeline Briefing" and assign it to Siri

Quick Add Job

This shortcut lets you quickly add a job from your phone:

1. Create a new shortcut
2. Add Ask for Input actions for:

- Company name (Text)

- Job title (Text)

- URL (URL, optional)

1. Add Get Contents of URL action:

- URL: https://www.orbytjobs.ai/api/mcp/jobs

- Method: POST

- Headers: Authorization: Bearer ext_your_token

- Request Body (JSON):

{
  "company": "[Company Input]",
  "title": "[Title Input]",
  "url": "[URL Input]",
  "status": "saved"
}

1. Add Show Notification with "Job added to Orbyt"

Interview Reminder

Build an automation that runs 30 minutes before calendar events tagged as interviews:

1. Go to Automation tab
2. Create a Personal Automation triggered by Calendar Event
3. Add Get Contents of URL to fetch /api/mcp/calendar
4. Parse the response to find today's interviews
5. Add Show Notification with interview details and company intel

Step 3: Add to Home Screen

1. Open your shortcut
2. Tap the share icon
3. Select Add to Home Screen
4. Choose an icon and name

Siri Integration

Any shortcut can be triggered by voice:

• "Hey Siri, pipeline briefing" to hear your job search status
• "Hey Siri, add a job" to run the quick-add shortcut
• "Hey Siri, what interviews do I have?" to check upcoming interviews

Available API Endpoints for Shortcuts

Tips

• Use Text actions to format API responses into readable summaries before speaking or displaying
• Store your API key in a Text action at the start of the shortcut and reference it with a variable (easier to update)
• Use If actions to branch based on response data (e.g., only notify if there are stale applications)
• Apple Watch can run simple shortcuts; keep API calls to one request for best performance
• Share shortcuts with friends who also use Orbyt by exporting via iCloud link

Base URL: https://www.orbytjobs.ai
Header:  Authorization: Bearer YOUR_API_KEY_HERE

Pipeline briefing:  GET /api/mcp/pipeline
Add a job:          POST /api/mcp/jobs
Upcoming events:    GET /api/mcp/calendar
Follow-ups:         GET /api/mcp/suggestions
Your profile:       GET /api/mcp/me