Notify API reference

Notify API · Setup-Status

get/v1/workspaces/{workspace_id}/setup-statusAuth

Get the setup checklist for Notify: what works, what is missing, and where to fix it.

Rows, in order: `notification_type` (not_set until an active type exists), `email` (attention while email is off, blocked while Notify has paused it), and, once a type uses email, `mail_sender` (the Mail workspace default sender: pass when its domain is verified) and `email_templates` (every Mail template name your types use exists in Mail). Notify sends email through ProductCraft Mail and holds no credential for it: Mail is read with your own access, so a key without Mail read access shows those rows as `attention`. `complete` is true once no row is `not_set` or `blocked`. Each `fix.href` is a console path. Computed on every request.

Path parameters

workspace_id*string · uuid

Id of the workspace.

Response · 200 The checklist, computed now.

checked_at*string · date-time

When the server computed these rows.

Example: "2026-10-16T12:00:00.000Z"

complete*boolean

True when no row is `not_set` or `blocked`. `attention` rows do not stop setup from being complete.

Example: false

rows*array

Checklist rows in the order they should be shown.

Example

Request

GET https://api.notify.productcraft.co/v1/workspaces/{workspace_id}/setup-status
Authorization: Bearer YOUR_TOKEN

Response

{
  "checked_at": "2026-10-16T12:00:00.000Z",
  "complete": false,
  "rows": [
    {
      "id": "redirect_origins",
      "title": "Sites allowed to start sign-in",
      "state": "blocked",
      "detail": "No site is allowed to start sign-in, so web sign-in is refused. Add the origin of your site, for example https://app.example.com.",
      "fix": {},
      "test": {}
    }
  ]
}