Celerity Apps logo Celerity Apps
DeepLinks

Web Server API Documentation

Endpoints for opening, creating and editing deep links, and exporting your DeepLinks history.

Overview

The web server provides endpoints for opening, creating and editing deep links, and for exporting a copy of your DeepLinks history. Below are the details for the available endpoints.

Endpoints

GET /open

Opens a deep link specified by the query parameters, either by its display name or a target URL. Only one is required.

Query Parameters:

Key Type Description
target String The deep link URL to open. Example: someapp://some/path.
name String The display name of a saved deep link. If provided, it attempts to find and open the corresponding deep link.

Responses:

  • 200 Success: The deep link was successfully opened.
  • 404 Not Found: No deep link with the given name exists.

POST /open (By name)

Processes and opens an existing deep link by its name.

Request Body:

Key Type Description Default Value
name String User-friendly name you assigned to the deep link. Required

POST /open (create and open)

Processes and opens a deep link from a JSON payload.

Request Body:

Key Type Description Default Value
targetUrlString String The deep link URL to be opened. Required
displayName String User-friendly name for the deep link. ""
pinnedColor String A predefined color name for visual pinning. See the list below for accepted values. Random
isPinned Boolean Marks the deep link as pinned. false
mixAudio Boolean Whether to mix audio with other playing audio sources. false

Accepted Values for pinnedColor:

  • Red
  • Orange
  • Yellow
  • Green
  • Mint
  • Teal
  • Blue
  • Indigo
  • Purple
  • Pink
  • Brown
  • Gray

Responses:

  • 200 Success: The deep link was successfully processed and opened.
  • 404 Not Found: No deep link with the given name exists.
  • 400 Bad Request: Required parameters are missing or invalid.

GET /history

Returns a JSON array of all saved deep links, including their attributes.

Response:

  • 200 Success: Returns the list of deep links.

Examples

GET /open

GET /open?target=someapp://some/path

POST /open

POST /open
Content-Type: application/json

{
  "target": "someapp://path/to/resource",
  "displayName": "Example Link",
  "pinnedColor": "Blue",
  "isPinned": true,
  "mixAudio": true
}