Log In Sign up
API Docs OAuth Clients Access Tokens

Navigation Links

Navigation links let add-ons install links into a space's navigation on Cobot. The link leads to a page with an iframe that points to a URL within the external app.

The iframe's width responds to the window's width.

When passing an app_data parameter to this link it is passed on to the iframe.

POST https://:sudomain.cobot.me/api/navigation_links

Create a link.

Authentication required:
yes, additionally user must be a space admin
Scope required
navigation
POST https://co-up.cobot.me/api/navigation_links

Body:

{
  "section": "admin/setup",
  "label": "My App",
  "iframe_url": "http://testapp.com/home"
}

Response:

{
  "section": "admin/setup",
  "label": "My App",
  "iframe_url": "http://testapp.com/home",
  "url": "https://co-up.cobot.me/api/navigation_links/cc7e75473a6911587b63d78f4e3f8eba",
  "user_url": "http://co-up.cobot.me/navigation_links/cc7e75473a6911587b63d78f4e3f8eba"
}

Response status is 201 on success and 422 if you pass invalid parameters.

section
Determines where the link appears.
  • admin/setup - in the side navigation of the setup section for admins
  • admin/manage - in the side navigation of the manage section for admins
  • admin/analyze - in the side navigation of the analyze section for admins
  • members - in the side navigation of the member section
label
The text of the link in the navigation
iframe_url
The URL the iframe or external link should point to. Four additional parameters will be passed to the URL: cobot_embed=true, cobot_subdomain=&lgt;subdomain>, cobot_user_id=<user-id> and cobot_locale=en. Apps should make sure that the user logged into the app matches the id from the iframe as users might log out of Cobot without the app realizing it. If they support i18n they should set their locale according to the parameter.
url
The API URL - used for example to delete the link.
user_url
URL of the page where the iframe is embedded. Apps can use this to redirect the user to the iframe.
type
options: 'iframe' or 'external' (opens link in new tab)
PATCH https://:sudomain.cobot.me/api/navigation_links/:id

Updates a link.

Authentication required:
yes, additionally user must be a space admin
Scope required
navigation
PATCH https://co-up.cobot.me/api/navigation_links/cc7e75473a6911587b63d78f4e3f8eba

Body:

{
  "section": "admin/manage",
  "label": "My Updated App",
  "iframe_url": "http://testapp.com/app"
}

Response:

{
  "section": "admin/manage",
  "label": "My Updated App",
  "iframe_url": "http://testapp.com/app",
  "url": "https://co-up.cobot.me/api/navigation_links/cc7e75473a6911587b63d78f4e3f8eba",
  "user_url": "http://co-up.cobot.me/navigation_links/cc7e75473a6911587b63d78f4e3f8eba"
}

Response status is 200 on success and 422 if you pass invalid parameters.

GET https://:subdomain.cobot.me/api/navigation_links

List an app's links.

Authentication required:
yes, additionally user must be a space admin
Scope required
navigation

URL:

GET https://co-up.cobot.me/api/navigation_links

Response:

[
  {
    "section": "admin/setup",
    "label": "My App",
    "iframe_url": "http://testapp.com/home",
    "url": "https://co-up.cobot.me/api/navigation_links/cc7e75473a6911587b63d78f4e3f8eba",
    "user_url": "http://co-up.cobot.me/navigation_links/cc7e75473a6911587b63d78f4e3f8eba"
  }
]

DELETE https://:subdomain.cobot.me/api/navigation_links/:link_id

Delete a link.

Authentication required:
yes, additionally user must be a space admin
Scope required
navigation

URL:

DELETE https://co-up.cobot.me/api/navigation_links/cc7e75473a6911587b63d78f4e3f8eba

Returns an empty response with the status 204.

back to index