Skip to content

x-callback-url

What's x-callback-url?

Picsew implements the x-callback-url protocol, a generic URL Scheme protocol. It allows you to communicate between different apps. Shortcuts, Launch Center Pro and other apps support x-callback-url, so Picsew also supports working with them.

Picsew's x-callback-url format is:

picsew://x-callback-url/[action]?[action parameters]&[x-callback parameters]

Want to skip the lengthy parameter documentation? Click the button below to start creating your x-callback-url.

Create URL

Action

Action Purpose Minimum Picsew version
scroll Use the specified images for Screenshot Stitching. 2.7.1
vert Use the specified images for Vertical Stitching. 2.7.1
hori Use the specified images for Horizontal Stitching. 2.7.1

Action Parameters

in

2.7.1 Required

Specifies how to get the input images.

Value Behavior
paste Gets images from the clipboard.
latest Gets the latest N images from the photo album; set N with count.
recent Automatically detects the most recent screenshots.

count

2.7.1 Required with in=latest

When in=latest, this is a required parameter, specify the number of images to get.

out

2.7.1 Required

Specifies how to output the stitching result.

Value Behavior
copy Copies the result to the clipboard.
save Saves the result to the photo album.
save_copy Saves the result to the photo album and copies it to the clipboard.

watermark

2.7.1 Optional

Specifies whether to add a watermark. By default, no watermark is added. The watermark text and position use the default watermark settings in the app; if those settings are not configured correctly, the result will not contain a watermark.

Value Behavior
single Adds one watermark at the default position of the result.
repeat Adds a watermark at the default position of every image.

border

2.7.2 Optional

Specifies whether and where to add borders. By default, no border is added. To specify the width, append _<0~100>, for example inside_60. The outside value and custom width suffix require Picsew 2.10 or later.

Value Behavior
inside Adds borders inside the result.
outside Adds borders outside the result.
all Adds borders inside and outside the result.

mockup-name

3.18.1 Optional

Specifies a Mockup file name. For available file names, open the "Mockup Parameters" help page inside the Picsew app.

mockup-name=iphone-air-sky-blue

mockup-background-width

3.18.1 Optional

Picsew 3.18.1+. Optional; enter an integer from 0 to 100 with a Mockup file name. Adjusts the background outside the device frame, not the frame itself or the stitching border.

This is a separate query parameter, used with mockup-name or its compatible alias mockup2; it is not nested inside either value.

picsew://x-callback-url/scroll?in=paste&out=save&mockup-name=iphone-air-sky-blue&mockup-background-width=50

mockup2

3.9.2 Optional

Legacy alias for mockup-name, retained for compatibility. Use mockup-name in new URLs (Picsew 3.18.1+).

mockup

2.7.1 Optional

An earlier parameter, such as mockup=black_iphone63. Device model suffixes were added in Picsew 2.8. Picsew still recognizes the parameter but continues to prompt the user to upgrade the Mockup. Do not use it in new URLs.

clean_status

2.7.1 Optional

Specifies whether the status bar needs to be cleared. When yes, the status bar is automatically cleared. The default is not clear.

remove_scrollbar

3.9.4 Optional

Specifies whether the scrollbars needs to be removed. When yes, the scrollbars is automatically removed. The default is not to remove.

delete_source

2.7.1 Optional

Specifies whether the original images needs to be deleted. When yes, the original images will be deleted. It is not deleted by default.