{"result":{"depiction_url":null,"edges":{"in_module":{"objects":[{"created":"2026-09-09T13:48:11Z","object_id":{"id":335,"is_a":["text","documentation","reference","module"],"name":"doc_core","title":"Zotonic Core","uri":"https:\/\/zotonic.com\/id\/335"},"seq":1}],"predicate":{"id":333,"is_a":["meta","predicate"],"name":"in_module","title":{"_type":"trans","tr":{"en":"In module"}},"uri":"https:\/\/zotonic.com\/id\/in_module"}},"subject":{"objects":[{"created":"2026-09-09T13:48:11Z","object_id":{"id":2555,"is_a":["categorization","keyword","keyword_information_type"],"name":"zotonic_topic_reference","title":"Reference","uri":"https:\/\/zotonic.com\/id\/2555"},"seq":1},{"created":"2026-09-09T13:48:11Z","object_id":{"id":2564,"is_a":["categorization","keyword","keyword_audience"],"name":"zotonic_topic_backend_developer","title":"Backend developer","uri":"https:\/\/zotonic.com\/id\/2564"},"seq":2},{"created":"2026-09-09T13:48:11Z","object_id":{"id":2608,"is_a":["categorization","keyword","keyword_domain"],"name":"zotonic_topic_routing_and_redirects","title":"Routing and redirects","uri":"https:\/\/zotonic.com\/id\/2608"},"seq":3},{"created":"2026-09-09T13:48:11Z","object_id":{"id":2625,"is_a":["categorization","keyword","keyword_architecture"],"name":"zotonic_topic_model","title":"Model","uri":"https:\/\/zotonic.com\/id\/2625"},"seq":4},{"created":"2026-09-09T13:48:11Z","object_id":{"id":2628,"is_a":["categorization","keyword","keyword_architecture"],"name":"zotonic_topic_dispatch_rule","title":"Dispatch rule","uri":"https:\/\/zotonic.com\/id\/2628"},"seq":5},{"created":"2026-09-09T13:48:11Z","object_id":{"id":2667,"is_a":["categorization","keyword","keyword_data_type"],"name":"zotonic_topic_url","title":"URL","uri":"https:\/\/zotonic.com\/id\/2667"},"seq":6}],"predicate":{"id":308,"is_a":["meta","predicate"],"name":"subject","title":{"_type":"trans","tr":{"en":"Keyword"}},"uri":"http:\/\/purl.org\/dc\/elements\/1.1\/subject"}}},"id":2437,"is_a":["text","documentation","reference","model"],"links":[{"rel":"self","target":"https:\/\/zotonic.com\/.zotonic\/websub\/topic\/2437"},{"rel":"hub","target":"https:\/\/zotonic.com\/.zotonic\/websub"}],"medium":null,"medium_url":null,"name":"doc_model_model_dispatch","page_url":{"en":"https:\/\/zotonic.com\/docs\/2437\/dispatch","x-default":"https:\/\/zotonic.com\/docs\/2437\/dispatch"},"preview_url":null,"resource":{"version":104,"pivot_location_lat":null,"title":"dispatch","is_authoritative":true,"body":"

Dispatch or generate URLs or page paths. Useful to check dispatch rules or for client side code to dispatch page paths.<\/p>\n

Dispatching URLs<\/h2>\n

The path<\/code> returns the matched dispatch rule, controller, controller options, language, bindings and other dispatch information.<\/p>\n

If no dispatch rule matches then 404 Not Found is returned.<\/p>\n

Example:<\/p>\n

curl -k 'https:\/\/example.test:8443\/api\/model\/dispatch\/get\/path\/nl\/page\/1234\/hello'\n<\/code><\/pre>\n
Returns:<\/p>\n
{\n    "result": {\n        "bindings": {\n            "id": "1234",\n            "z_language": "nl",\n            "zotonic_site": "example",\n            "zotonic_dispatch_path": [\n                "page",\n                "1234",\n                "hello"\n            ],\n            "zotonic_dispatch": "page",\n            "slug": "hello"\n        },\n        "controller": "controller_page",\n        "site": "example",\n        "language": "nl",\n        "dispatch_rule": "page",\n        "path_tokens": [\n            "page",\n            "1234",\n            "hello"\n        ],\n        "controller_options": {\n            "template": {\n                "template": "page.tpl",\n                "is_catinclude": true\n            },\n            "zotonic_dispatch_file": "dispatch",\n            "zotonic_dispatch_module": "mod_site_whatwebwhat"\n        }\n    },\n    "status": "ok"\n}\n<\/code><\/pre>\n
Creating URLs<\/h2>\n
URLs or page paths can also be requested using the url_for<\/code> method. Here the name of the dispatch rule is padded,\noptionally with any extra arguments.<\/p>\n
Example:<\/p>\n
curl -k 'https:\/\/example.test:8443\/api\/model\/dispatch\/get\/url_for\/admin'\n<\/code><\/pre>\n
Returns:<\/p>\n
{"result":"\/en\/admin","status":"ok"}\n<\/code><\/pre>\n
Or, use abs_url_for<\/code> if a complete URL with domain is needed:<\/p>\n
curl -k 'https:\/\/example.test:8443\/api\/model\/dispatch\/get\/abs_url_for\/admin'\n<\/code><\/pre>\n
Returns:<\/p>\n
{"result":"https:\/\/example.com\/en\/admin","status":"ok"}\n<\/code><\/pre>\n
And for more complex URLs:<\/p>\n
curl -k 'https:\/\/example.test:8443\/api\/model\/dispatch\/get\/url_for\/page?id=1234&slug=foo&a=1&bar=baz'\n<\/code><\/pre>\n
Returns:<\/p>\n
{"result":"\/en\/page\/1234\/foo?a=1&bar=baz","status":"ok"}\n<\/code><\/pre>\n
Here the selected dispatch rule was something like:<\/p>\n
{page, [ "page", id, slug ], controller_page, [ {template, "page.tpl"} ]}\n<\/code><\/pre>\n
Because id<\/code> and slug<\/code> are part of the path, they are included in the generated URL path, the other arguments are added\nas query parameters.<\/p>\n
Available Model API Paths<\/h2>\n
Method<\/th>Path pattern<\/th>Description<\/th><\/tr><\/thead>
get<\/code><\/td>\/url<\/code><\/td>Dispatch full URL from payload field url<\/code>, returning matched rule\/controller\/options\/bindings for this site only (enoent<\/code> on mismatch or no match). No further lookups.<\/td><\/tr>
get<\/code><\/td>\/url\/+url<\/code><\/td>Dispatch full URL +url<\/code>, returning matched rule\/controller\/options\/bindings when it resolves to the current site; otherwise enoent<\/code>. No further lookups.<\/td><\/tr>
get<\/code><\/td>\/path<\/code><\/td>Dispatch path from payload field path<\/code>, returning matched rule\/controller\/options\/bindings (enoent<\/code> when no rule matches). No further lookups.<\/td><\/tr>
get<\/code><\/td>\/path\/...<\/code><\/td>Dispatch supplied path segments (percent-encoded and joined) and return matched rule\/controller\/options\/bindings.<\/td><\/tr>
get<\/code><\/td>\/url_for\/+name\/...<\/code><\/td>Generate relative URL for dispatch rule +name<\/code> using payload args (path vars consumed by rule, remaining args as query params); enoent<\/code> when rule is unknown.<\/td><\/tr>
get<\/code><\/td>\/abs_url_for\/+name\/...<\/code><\/td>Generate absolute URL for dispatch rule +name<\/code> from url_for<\/code> result and current site host\/scheme; enoent<\/code> when rule is unknown.<\/td><\/tr><\/tbody><\/table>\n
\/+name<\/code> marks a variable path segment. A trailing \/...<\/code> means extra path segments are accepted for further lookups.<\/p>","slug":"dispatch","is_protected":false,"visible_for":0,"tz":"UTC","language":["en"],"doc_source_hash":"7aa8dc8c467670b271f0ddd5ff54191caa8febe05bc9ce5b4bef62737016239d","is_featured":false,"content_group_id":{"id":2551,"is_a":["meta","content_group"],"name":"content_group_imported_docs","title":"Imported documentation","uri":"https:\/\/zotonic.com\/id\/content_group_imported_docs"},"category_id":{"id":322,"is_a":["meta","category"],"name":"model","title":"Models","uri":"https:\/\/test.zotonic.com\/id\/322"},"doc_source_path":"apps\/zotonic_core\/src\/models\/m_dispatch.erl","publication_start":"2025-07-15T08:16:39Z","github_url":"https:\/\/github.com\/zotonic\/zotonic\/blob\/master\/apps\/zotonic_core\/src\/models\/m_dispatch.erl","pivot_location_lng":null,"doc_source_kind":"model","name":"doc_model_model_dispatch","is_unfindable":false,"is_published":true,"pivot_geocode":null,"created":"2025-07-15T08:16:39Z","uri":null,"doc_status":"current","is_dependent":false,"erlang_app":"zotonic_core","publication_end":"9999-06-01T00:00:00Z","modifier_id":{"id":1,"is_a":["person"],"name":"administrator","title":"Site Administrator","uri":"https:\/\/zotonic.com\/id\/1"},"privacy":0,"doc_source_commit":"28493fb676b2d92727e68d4fba20d89c56cf8ead\n","erlang_module":"m_dispatch","creator_id":{"id":336,"is_a":["person","robot"],"name":"gitbot","title":"Git","uri":"https:\/\/zotonic.com\/id\/336"},"modified":"2026-10-15T20:07:37Z","title_slug":"dispatch"},"uri":"https:\/\/zotonic.com\/id\/2437","uri_template":"https:\/\/zotonic.com\/id\/:id","websub":{"hub":"https:\/\/zotonic.com\/.zotonic\/websub","topic":"https:\/\/zotonic.com\/.zotonic\/websub\/topic\/2437"}},"status":"ok"}