Send workspace notifications

Sends a push notification to active Expo registrations in the resolved workspace and returns Expo ticket ids for later receipt checks.

POST/api/v1/notifications/send

Sends a push notification to active Expo registrations in the resolved workspace and returns Expo ticket ids for later receipt checks.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

title*nonEmptyString

a non empty string

Length1 <= length

body*nonEmptyString

a non empty string

Length1 <= length

data?

subtitle?nonEmptyString

a non empty string

Length1 <= length

sound?string

Value in"default"

badge?nonNegative

a non-negative number

Range0 <= value

channelId?nonEmptyString

a non empty string

Length1 <= length

ttlSeconds?positive

a positive number

Range0 < value

priority?string

Value in"default" | "normal" | "high"

userIds?array<>

an array of at least 1 item(s)

Items1 <= items

installationIds?array<>

an array of at least 1 item(s)

Items1 <= items

Response Body

`application/json`

curl -X POST "https://loading/api/v1/notifications/send" \  -H "Content-Type: application/json" \  -d '{    "title": "Pipeline failed",    "body": "The nightly sync failed in production.",    "data": {      "url": "/chat",      "workspaceHandle": "acme-growth-team"    },    "sound": "default",    "priority": "high",    "userIds": [      "user_01HXYZ1234567890ABCDEFG"    ]  }'

{
  "registrationCount": 1,
  "acceptedCount": 1,
  "failedCount": 0,
  "results": [
    {
      "installationId": "mobile-installation-7njm6y3u",
      "userId": "user_01HXYZ1234567890ABCDEFG",
      "expoPushTokenPreview": "ExponentPushToken[...7S9w]",
      "ticketId": "9bd7b2c4-3775-4890-ad5d-a18a183cab8b",
      "status": "ok",
      "message": null,
      "error": null,
      "details": null
    }
  ]
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

{
  "code": "authentication_required",
  "message": "Authentication required. Send Authorization: Bearer <api-key>, x-api-key, or a signed-in session."
}

{
  "code": "insufficient_permissions",
  "message": "This API key does not have the required permission.",
  "details": {
    "requiredPermission": "resource.action"
  }
}

{
  "code": "internal_error",
  "message": "An unexpected server error occurred."
}

Send workspace notifications

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`