Skip to content
AdVentur.aiAdVentur.aiAdVentur.ai Docs

Notifications API

7 endpoints. Every path is relative to the API base URL and needs a bearer token unless it is marked public. See the REST API overview for authentication, errors and pagination.

GET/v1/orgs/{orgId}/notifications

Bearer token

Returns in-app notifications for the authenticated member in this organization, newest first. Dismissed notifications are omitted.

Path parameters

  • orgIdstring (uuid)required

Query parameters

  • unreadOnlystringrequired

    one of true, false

  • pageinteger
  • limitinteger

Responses

200Returns in-app notifications for the authenticated member in this organization, newest first. Dismissed notifications are omitted.
  • dataobjectrequired
    Fields
    • itemsarray<object>required
      Item fields
      • idstring (uuid)required
      • orgIdstring (uuid) | nullrequired
      • typestringrequired
      • titlestringrequired
      • bodystring | nullrequired
      • hrefstring | nullrequired
      • tierstringrequired

        one of action_required, meaningful_win, routine

      • channelsarray<string>required
      • statusstringrequired

        one of pending, sent, failed, read

      • dedupeKeystringrequired
      • readAtstring | nullrequired
      • dismissedAtstring | nullrequired
      • emailSentAtstring | nullrequired
      • createdAtstringrequired
      • metadataobject | null
    • totalintegerrequired
    • unreadCountintegerrequired
    • pageintegerrequired
    • limitintegerrequired
Request
curl -X GET "https://api.adventur.ai/v1/orgs/$ORG_ID/notifications?unreadOnly=true" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

POST/v1/orgs/{orgId}/notifications/{notificationId}/dismiss

Bearer token

Clears one notification from the authenticated member's inbox. This is not the same as marking it read.

Path parameters

  • orgIdstring (uuid)required
  • notificationIdstring (uuid)required

Responses

200Clears one notification from the authenticated member's inbox. This is not the same as marking it read.
  • dataobjectrequired
    Fields
    • idstring (uuid)required
    • dismissedAtstringrequired
Request
curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/notifications/$NOTIFICATION_ID/dismiss" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

POST/v1/orgs/{orgId}/notifications/{notificationId}/read

Bearer token

Marks one notification as read for the authenticated member.

Path parameters

  • orgIdstring (uuid)required
  • notificationIdstring (uuid)required

Responses

200Marks one notification as read for the authenticated member.
  • dataobjectrequired
    Fields
    • idstring (uuid)required
    • readAtstringrequired
    • status"read"required
Request
curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/notifications/$NOTIFICATION_ID/read" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

POST/v1/orgs/{orgId}/notifications/dismiss-all

Bearer token

Dismisses every active notification for the authenticated member in this organization, so the inbox and bell menu are empty.

Path parameters

  • orgIdstring (uuid)required

Responses

200Dismisses every active notification for the authenticated member in this organization, so the inbox and bell menu are empty.
  • dataobjectrequired
    Fields
    • dismissedCountintegerrequired
Request
curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/notifications/dismiss-all" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

GET/v1/orgs/{orgId}/notifications/preferences

Bearer token

Returns email/in-app preference toggles for the authenticated member.

Path parameters

  • orgIdstring (uuid)required

Responses

200Returns email/in-app preference toggles for the authenticated member.
  • dataobjectrequired
    Fields
    • orgIdstring (uuid)required
    • userIdstring (uuid)required
    • emailEnabledbooleanrequired
    • inAppEnabledbooleanrequired
    • actionRequiredEmailbooleanrequired
    • meaningfulWinEmailbooleanrequired
    • routineEmailbooleanrequired
    • digestEnabledbooleanrequired
    • approvalRemindersEmailbooleanrequired
    • updatedAtstring | nullrequired
Request
curl -X GET "https://api.adventur.ai/v1/orgs/$ORG_ID/notifications/preferences" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

PUT/v1/orgs/{orgId}/notifications/preferences

Bearer token

Updates email/in-app preference toggles for the authenticated member.

Path parameters

  • orgIdstring (uuid)required

Request body application/json

  • emailEnabledboolean
  • inAppEnabledboolean
  • actionRequiredEmailboolean
  • meaningfulWinEmailboolean
  • routineEmailboolean
  • digestEnabledboolean
  • approvalRemindersEmailboolean

Responses

200Updates email/in-app preference toggles for the authenticated member.
  • dataobjectrequired
    Fields
    • orgIdstring (uuid)required
    • userIdstring (uuid)required
    • emailEnabledbooleanrequired
    • inAppEnabledbooleanrequired
    • actionRequiredEmailbooleanrequired
    • meaningfulWinEmailbooleanrequired
    • routineEmailbooleanrequired
    • digestEnabledbooleanrequired
    • approvalRemindersEmailbooleanrequired
    • updatedAtstring | nullrequired
Request
curl -X PUT "https://api.adventur.ai/v1/orgs/$ORG_ID/notifications/preferences" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

POST/v1/orgs/{orgId}/notifications/read-all

Bearer token

Marks every unread notification for the authenticated member as read.

Path parameters

  • orgIdstring (uuid)required

Responses

200Marks every unread notification for the authenticated member as read.
  • dataobjectrequired
    Fields
    • markedCountintegerrequired
Request
curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/notifications/read-all" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"