Sites & Organisation

Notifications

An in-product notification feed for users, scoped per site. Use these endpoints to list, group, mark as read/unread, and acknowledge notifications raised by integrations and background jobs.

get/grouped-notifications

Get a grouped summary of notifications

listGroupedNotifications

Returns the in-product notifications for the currently authenticated user, grouped by notification type. Use this view to render the notification tray's collapsed-by-default layout — notifications within each group contains the individual records, and the top-level meta exposes read/unread counts and per-type totals.

Query parameters

site_idstringrequired
Scope the notifications to a single Site. When not specified the platform falls back to the user's default site. Use this when a user works across multiple sites and you want their site-specific inbox.

Responses

200
Notifications were successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.

curl "https://api.playground.try.be/grouped-notifications?site_id=beddda88-947d-4bd8-8f0c-828b187f93c3" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/grouped-notifications?site_id=beddda88-947d-4bd8-8f0c-828b187f93c3', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/grouped-notifications?site_id=beddda88-947d-4bd8-8f0c-828b187f93c3",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/grouped-notifications?site_id=beddda88-947d-4bd8-8f0c-828b187f93c3', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/grouped-notifications?site_id=beddda88-947d-4bd8-8f0c-828b187f93c3", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

Notifications were successfully retrieved.

{
  "data": [
    {
      "type": "string",
      "title": "An order was created by rezlynx",
      "notifications": [
        {
          "id": "beddda88-947d-4bd8-8f0c-828b187f93b2",
          "title": "An order was created by rezlynx",
          "type": "guestline_order_created",
          "subject_id": "beddda88-947d-4bd8-8f0c-828b187f93b2",
          "subject_type": "Order",
          "site_id": "beddda88-947d-4bd8-8f0c-828b187f93b2",
          "created_at": "2019-01-15T11:00:00.000Z",
          "read_at": "2019-01-15T11:00:00.000Z",
          "acknowledged_by": {
            "id": "beddda88-947d-4bd8-8f0c-828b187f93b2",
            "name": "Jane Smith"
          },
          "data": {},
          "actions": [
            {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          ]
        }
      ],
      "read": true,
      "count": 1,
      "date": "2026-01-15T09:30:00+00:00"
    }
  ],
  "meta": {
    "total": 1,
    "counts": {},
    "total_read": 1,
    "total_unread": 1
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

get/notifications

Get notifications for the authenticated user

listNotifications

Returns the in-product notifications raised for the currently authenticated user at the given site, ordered most recent first. Use the optional filters to narrow by read status or type.

Query parameters

site_iduuidrequired
Scope the notifications to a single Site. When not specified the platform falls back to the user's default site. Use this when a user works across multiple sites and you want their site-specific inbox.
readbooleanoptional
Filter results by read state. When true, only previously-read notifications are returned; when false, only unread.
typestring[]optional
A list of notification types to filter by, e.g. guestline_order_created.
pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page

Responses

200
Notifications were successfully retrieved.
401
The user is unauthenticated
403
The authenticated user does not have permission.

curl "https://api.playground.try.be/notifications?site_id=beddda88-947d-4bd8-8f0c-828b187f93c3" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/notifications?site_id=beddda88-947d-4bd8-8f0c-828b187f93c3', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/notifications?site_id=beddda88-947d-4bd8-8f0c-828b187f93c3",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/notifications?site_id=beddda88-947d-4bd8-8f0c-828b187f93c3', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/notifications?site_id=beddda88-947d-4bd8-8f0c-828b187f93c3", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

Notifications were successfully retrieved.

{
  "data": [
    {
      "id": "beddda88-947d-4bd8-8f0c-828b187f93b2",
      "title": "An order was created by rezlynx",
      "type": "guestline_order_created",
      "subject_id": "beddda88-947d-4bd8-8f0c-828b187f93b2",
      "subject_type": "Order",
      "site_id": "beddda88-947d-4bd8-8f0c-828b187f93b2",
      "created_at": "2019-01-15T11:00:00.000Z",
      "read_at": "2019-01-15T11:00:00.000Z",
      "acknowledged_by": {
        "id": "beddda88-947d-4bd8-8f0c-828b187f93b2",
        "name": "Jane Smith"
      },
      "data": {},
      "actions": [
        {
          "label": "View order",
          "type": "view_order",
          "url": "https://app.try.be/orders/beddda88-947d-4bd8-8f0c-828b187f93b2"
        }
      ]
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api",
    "total_read": 1,
    "total_unread": 1
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

post/notifications/{notificationId}/acknowledge

Mark a notification as acknowledged

actionAcknowledgeNotification

Records that the currently authenticated user has acknowledged the notification — typically used by team-wide notifications that need an explicit human sign-off (as opposed to merely being marked read). The acknowledging user is recorded on the acknowledged_by field of the notification.

Path parameters

notificationIduuidrequired
Stable identifier for the in-app notification. Only the user the notification was delivered to can read, acknowledge or mark it (un)read; requests from other users return 404.

Responses

204
The notification was successfully marked as acknowledged.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X POST "https://api.playground.try.be/notifications/beddda88-947d-4bd8-8f0c-828b187f93c3/acknowledge" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/notifications/beddda88-947d-4bd8-8f0c-828b187f93c3/acknowledge', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/notifications/beddda88-947d-4bd8-8f0c-828b187f93c3/acknowledge",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/notifications/beddda88-947d-4bd8-8f0c-828b187f93c3/acknowledge', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/notifications/beddda88-947d-4bd8-8f0c-828b187f93c3/acknowledge", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The notification was successfully marked as acknowledged.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

post/notifications/{notificationId}/read

Mark a notification as read

actionMarkNotificationAsRead

Marks the specified notification as read for the currently authenticated user. To mark several notifications in one request, use actionBulkMarkNotificationsAsRead.

Path parameters

notificationIduuidrequired
Stable identifier for the in-app notification. Only the user the notification was delivered to can read, acknowledge or mark it (un)read; requests from other users return 404.

Responses

204
The notification was successfully marked as read.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X POST "https://api.playground.try.be/notifications/beddda88-947d-4bd8-8f0c-828b187f93c3/read" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/notifications/beddda88-947d-4bd8-8f0c-828b187f93c3/read', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/notifications/beddda88-947d-4bd8-8f0c-828b187f93c3/read",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/notifications/beddda88-947d-4bd8-8f0c-828b187f93c3/read', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/notifications/beddda88-947d-4bd8-8f0c-828b187f93c3/read", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The notification was successfully marked as read.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

post/notifications/{notificationId}/unread

Mark a notification as unread

actionMarkNotificationAsUnread

Reverses a previous read or bulk-read action by clearing the read_at timestamp on the notification for the currently authenticated user.

Path parameters

notificationIduuidrequired
Stable identifier for the in-app notification. Only the user the notification was delivered to can read, acknowledge or mark it (un)read; requests from other users return 404.

Responses

204
The notification was successfully marked as unread.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X POST "https://api.playground.try.be/notifications/beddda88-947d-4bd8-8f0c-828b187f93c3/unread" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/notifications/beddda88-947d-4bd8-8f0c-828b187f93c3/unread', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/notifications/beddda88-947d-4bd8-8f0c-828b187f93c3/unread",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/notifications/beddda88-947d-4bd8-8f0c-828b187f93c3/unread', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/notifications/beddda88-947d-4bd8-8f0c-828b187f93c3/unread", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The notification was successfully marked as unread.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

post/notifications/bulk-mark-as-read

Bulk-mark notifications as read

actionBulkMarkNotificationsAsRead

Marks every notification whose ID is supplied as read for the currently authenticated user. IDs that don't correspond to a notification visible to the caller are silently skipped.

Query parameters

site_iduuidrequired
Scope the notifications to a single Site. When not specified the platform falls back to the user's default site. Use this when a user works across multiple sites and you want their site-specific inbox.

Request body

notification_idsstring[]required
The IDs of the notifications to mark as read.

Responses

204
Notifications were successfully marked as read.
401
The user is unauthenticated
403
The authenticated user does not have permission.
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/notifications/bulk-mark-as-read?site_id=beddda88-947d-4bd8-8f0c-828b187f93c3" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "notification_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}'

const response = await fetch('https://api.playground.try.be/notifications/bulk-mark-as-read?site_id=beddda88-947d-4bd8-8f0c-828b187f93c3', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "notification_ids": [
      "00000000-0000-0000-0000-000000000000"
    ]
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/notifications/bulk-mark-as-read?site_id=beddda88-947d-4bd8-8f0c-828b187f93c3",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "notification_ids": [
            "00000000-0000-0000-0000-000000000000"
        ]
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/notifications/bulk-mark-as-read?site_id=beddda88-947d-4bd8-8f0c-828b187f93c3', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'notification_ids' => [
                '00000000-0000-0000-0000-000000000000'
            ]
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"notification_ids": []interface{}{
			"00000000-0000-0000-0000-000000000000",
		},
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/notifications/bulk-mark-as-read?site_id=beddda88-947d-4bd8-8f0c-828b187f93c3", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

Notifications were successfully marked as read.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}