Grouped actionable notifications for the current org

GET

/api/v1/notifications

const url = 'https://api.yggy.tech/api/v1/notifications?include=recent';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.yggy.tech/api/v1/notifications?include=recent' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth
apiKeyAuth

Parameters

Query Parameters

include

string

Allowed values: recent

Header Parameters

host

string | null

x-yggy-organization-id

string | null

Responses

200

Notifications feed

application/json

object

actionable

required

object

workflows

required

Array<object>

object

required

string

group

required

string

Allowed values: workflows requests

title

required

string

status

required

string

summary

required

string

updatedAt

required

string

documentId

string

projectExternalId

string

step

string | null

progress

number

dismissable

boolean

requests

required

Array<object>

object

required

string

group

required

string

Allowed values: workflows requests

title

required

string

status

required

string

summary

required

string

updatedAt

required

string

documentId

string

projectExternalId

string

step

string | null

progress

number

dismissable

boolean

recent

required

Array<object>

object

required

string

group

required

string

Allowed values: workflows requests

title

required

string

status

required

string

summary

required

string

updatedAt

required

string

documentId

string

projectExternalId

string

step

string | null

progress

number

dismissable

boolean

counts

required

object

actionable

required

number

workflows

required

number

requests

required

number

Example

{
  "actionable": {
    "workflows": [
      {
        "group": "workflows"
      }
    ],
    "requests": [
      {
        "group": "workflows"
      }
    ]
  },
  "recent": [
    {
      "group": "workflows"
    }
  ]
}