Перейти к основному содержимому
  1. Документация/

Справочник настроек

Server Configuration
#

The core connection settings for your PocketHook server.

Server URL
#

TypeText field (URL)
DefaultEmpty
Stored iniOS Keychain

The HTTPS endpoint where PocketHook sends your chat messages. Only HTTPS URLs are accepted — HTTP is rejected for security. This is the primary endpoint your server listens on.

Authentication Token
#

TypeSecure text field
DefaultEmpty
Length10–1,000 characters
Stored iniOS Keychain

Bearer token sent in the Authorization header with every request. Your server can use this to verify that requests come from your device. Stored securely in the iOS Keychain — never in plain text.

OpenClaw Compatible
#

TypeToggle
DefaultOFF

Enable if your server uses the OpenClaw platform or any OpenAI-compatible Chat Completions API. When enabled, PocketHook sends messages in the OpenAI chat format and parses inline shortcut markers ([SHORTCUT:name], [DATA:{...}], [URL:...]) from the response. An x-openclaw-agent-id header is included with requests.

Test Connection
#

Button that sends a test request to your configured server. Displays:

  • Response time in milliseconds
  • Health check result (if enabled)
  • Error details if the connection fails

Use this after changing your Server URL or Auth Token to verify everything works.


Network
#

Fine-tune timeout behavior for different types of operations.

Request Timeout
#

TypeStepper (±5 seconds)
Default5 seconds
Range1–600 seconds

How long PocketHook waits for the server to start responding to a request. If your server does heavy processing (like calling an AI model), increase this value. For simple webhook servers, the default of 5 seconds is usually fine.

Resource Timeout
#

TypeStepper (±10 seconds)
Default60 seconds
Range30–600 seconds

Maximum time for the entire response to complete, including data transfer. This should be higher than the Request Timeout. Increase if your server returns large payloads or has slow upload speeds.

Health Check
#

TypeToggle
DefaultOFF

Enable server health monitoring. When active, PocketHook sends a GET request to the Health Check URL during connection tests and displays whether your server reports healthy.

Health Check URL
#

TypeText field (URL)
DefaultEmpty
Visible whenHealth Check is ON

A separate HTTPS endpoint that returns plain text true or false. This URL is pinged during connection tests to verify your server is operational. Useful when your main API endpoint is behind authentication but you want a simple status check.


Automation
#

Control how PocketHook executes iOS Shortcuts triggered by server responses.

iOS Shortcuts
#

TypeToggle
DefaultON

Master toggle for Shortcut execution. When OFF, PocketHook still displays messages from the server but ignores any shortcut fields in responses. Useful for debugging or temporarily disabling automations.

Delay Between Shortcuts
#

TypeSlider
Default2.0 seconds
Range0.5–10.0 seconds

Wait time between executing consecutive shortcuts when the server returns multiple automations in a single response. Increase this if your shortcuts depend on each other (e.g., the first shortcut creates a file that the second one reads).

Shortcut Timeout
#

TypeSegmented picker
Default5 minutes (300s)
Options30s, 1 min, 2 min, 5 min

Maximum time to wait for each individual shortcut to finish before PocketHook considers it timed out. Long-running shortcuts (like ones that process media or make multiple API calls) may need the full 5 minutes.


Personal UI
#

Embed a custom web interface directly in PocketHook.

Personal UI
#

TypeToggle
DefaultOFF

Show a dedicated tab with an embedded web view. When enabled, a new tab appears in the main navigation where your custom web page is displayed. The page is preloaded for instant display and supports pull-to-refresh.

Personal UI URL
#

TypeText field (URL)
DefaultEmpty
Visible whenPersonal UI is ON

The URL to display in the Personal UI tab. Both HTTP and HTTPS are accepted (HTTPS recommended). This could be a dashboard, admin panel, or any web page you want quick access to alongside your chat.


Links#

Configure how PocketHook handles URLs from server responses.

Links Tab#

TypeToggle
DefaultON

Show or hide the Links tab in the main navigation. When enabled, all URLs received from server responses are saved and displayed in a dedicated tab with rich link previews, search, and delete functionality.

Auto-open URLs
#

TypeToggle
DefaultON

When enabled, PocketHook automatically opens URLs from server responses in your default browser. When disabled, URLs are still saved to the Links tab (if enabled) but won’t open automatically.


Language
#

Customize the app and dictation language.

App Language
#

TypePicker
DefaultSystem Default
OptionsSystem Default, English, Español

Override the app’s display language independently of your device language. When set to “System Default”, PocketHook follows your iOS language setting.

Dictation Language
#

TypePicker
DefaultSystem locale
Options21 languages

Language used for voice dictation (speech-to-text) in the chat input. Available languages:

LanguageCode
English (US)en-US
English (UK)en-GB
Spanish (Spain)es-ES
Spanish (Mexico)es-MX
Frenchfr-FR
Germande-DE
Italianit-IT
Portuguese (Brazil)pt-BR
Portuguese (Portugal)pt-PT
Catalanca-ES
Chinese (Simplified)zh-CN
Japaneseja-JP
Koreanko-KR
Arabicar-SA
Russianru-RU
Dutchnl-NL
Swedishsv-SE
Polishpl-PL
Turkishtr-TR
Thaith-TH
Vietnamesevi-VN

Background Tasks
#

Periodically check for pending tasks even when the app is in the background.

Background Tasks
#

TypeToggle
DefaultOFF

Enable background polling. When active, PocketHook periodically sends a GET request to the Polling URL. If the response is true, it sends the Fetch Message to your main server when the app opens. Requires notification permission to alert you of pending tasks.

Check Interval
#

TypeSegmented picker
Default15 minutes
Options5 min, 15 min, 30 min, 1 hr, 2 hr

How often PocketHook checks the Polling URL in the background. Shorter intervals mean faster detection of pending tasks but use more battery. iOS may adjust the actual frequency based on device usage patterns.

Polling URL
#

TypeText field (URL)
DefaultEmpty
Visible whenBackground Tasks is ON

HTTPS endpoint that PocketHook polls at the configured interval. Must return plain text true (tasks pending) or false (no tasks). This is a lightweight check — your server should respond quickly without heavy processing.

Agent Server: Use https://your-host/jobs (adjust host and port to match your setup).

Fetch Message
#

TypeText field
DefaultfetchPendingTasks
Max length10,000 characters

The message sent to your main server when a background check finds pending tasks and the app opens. The server response appears in chat like any other message. Customize this to trigger specific server-side behavior.


Data Management
#

Monitor and manage your stored messages.

Messages Stored
#

TypeRead-only display
Format“X of 500 messages”

Shows how many messages are currently stored. The indicator is color-coded:

  • Green — Under 70% capacity
  • Orange — 70–90% capacity
  • Red — Over 90% capacity

When the 500-message limit is reached, the oldest messages are automatically deleted to make room for new ones.

Export Conversation
#

Button that exports all stored messages as a JSON file via the iOS share sheet. You can save the file, AirDrop it, or share it with any app. Useful for backing up conversations or analyzing message history.

Delete All Messages
#

Destructive button that permanently removes all stored messages. Requires confirmation before executing. This action cannot be undone.


About
#

Read-only information about your PocketHook installation.

FieldDescription
App VersionCurrent PocketHook version (e.g., 1.0.0)
BuildBuild number for this release
iOS VersioniOS/iPadOS version running on your device