Schematy X-Callback-Url
nozbe4://x-callback-url schemes
Please bear in mind that this option is for advanced users.
X-Callback-url schemes is a standard for links to open apps in specified view or to trigger performing some action inside an app.
Learn more here:
URL scheme is a special type of link that starts with nozbe4:// and works just like normal https:// links you use every day. Instead of opening a webpage, it opens a specific view in the Nozbe app. Here is an example: nozbe4://goto/teams/TeamID/priority - it opens Nozbe in the Priority view. Below you will find technical documentation.
We implement x-callback-url protocol in our iOS, Android, macOS and Windows apps. It is a useful method for creating workflows and shortcuts from other apps to Nozbe views and actions.
General URL structure
URL Scheme actions look like this:
nozbe4://x-callback-url/ACTION_NAME?secret=YOUR_SECRET&x-success=URL&x-error=URL¶m1=VALUE1¶m2=VALUE2
?x-success=URL- (optional) this URL will be opened if action is performed successfully, with?x-source=Nozbeappended (and optionally other parameters)?x-error=URL- (optional) this URL will be opened on error, with?errorCode=1&errorMessage=Some+Error+Messageappended. If not provided, error will be displayed to the user instead?secret=YOUR_SECRET- (required!) - authentication code that can be generated by hitting the gear icon → Settings→Advanced→Automate with x-callback-url. This code should remain secret. Do not share the code with anyone!
Actions
/goto command
The simplest action that opens specific task list in Nozbe. To get a url to the list, you can use the “Copy list link” option in its menu or open Nozbe in a browser and copy the url from address bar. Then replace https://nozbe.app part with nozbe4://goto
Examples:
nozbe4://goto/teams/zR17yVDEDrpBbi8x/single_tasks - opens Single Tasks view in a space with ID: zR17yVDEDrpBbi8x
This one action only opens the view so it does not require ?secret=YOUR_SECRET parameter
Launching Quick Add window
nozbe4://goto/teams/zR17yVDEDrpBbi8x/quick_add - opens Quick Add window in a space with ID: zR17yVDEDrpBbi8x
Launching Jump To window
nozbe4://goto/teams/zR17yVDEDrpBbi8x/jump_to - opens Jump To window in a space with ID: zR17yVDEDrpBbi8x
Launching specific tag
nozbe4://goto/teams/zR17yVDEDrpBbi8x/tags/6fxaXuTFwaqd13QV - opens tag with ID 6fxaXuTFwaqd13QV in a space with ID: zR17yVDEDrpBbi8x
Launching specific project
nozbe4://goto/teams/zR17yVDEDrpBbi8x/projects/mfdcza541h8g20hz - opens project with ID mfdcza541h8g20hz in a space with ID: zR17yVDEDrpBbi8x
/add_task command
Required parameters:
?project_id=PROJECT_ID- required. To get the project ID, go to that project in Nozbe, hit the “…” icon on the app’s top bar, then choose “Copy task list link”. The string of symbols afterprojects/is your project ID.?name=NAME- required
Optional:
?is_priority=(true|false)?responsible_id=ID- ID of member responsible for task. If blank (?responsible_id=), task won’t be assigned. If not provided at all, it will default to YOU?due_at=TIMESTAMP- Due date for task, expressed as millisecond (!) epoch time?is_all_day=true- pass if due date is a full day, without time specified?comment=TEXT- optional comment to append to task
Returns on success:
?task_id=ID
Example:
nozbe4://x-callback-url/add_task?project_id=u79rr9gfqszxtn45&name=Added%20with%20url&secret=abcdef - adds task “Added with url” to a project with ID: u79rr9gfqszxtn45.
Change secret=abcdef to your individual secret code.
/update_task command
Required:
?task_id=ID
Optional:
?is_priority=(true|false)- marks task as priority/not priority?is_completed=(true|false)- marks task as completed/not completed
Example:
nozbe4://x-callback-url/update_task?task_id=abcd1efgh2dcba3j&is_completed=true&secret=abcdef - Completes task with ID: abcd1efgh2dcba3j
Change secret=abcdef into your individual secret code.
/add_project command
Required:
?team_id=ID?name=NAME
Optional:
?description=?is_open=true(true - project has open access, false - project is private to you)?color=COLOR_NAME, one of:red, yellow, sand, darkgreen, stone, pink, orange, dustpink, olive, lightblue, lightpink, ocher, taupe, green, blue, heather, brown, burntsienna, aquamarine, ultramarine, purple, karmin, mauve, teal, indigo, deeppurple, aubergine, midnight, ocean, navy, pedro, toto, fluffy, felus, luna, rufus, maja, elwi
Returns:
?project_id=ID
Example:
nozbe4://x-callback-url/add_project?team_id=u79rr9gfqszxtn45&name=Project%20added%20with%20url&secret=abcdef - adds project “Project added with url” in a workspace with ID: u79rr9gfqszxtn45.
Change secret=abcdef into your individual secret code.
