Notify API reference

Notify API · Client

post/v1/client/inbox/{item_id}/interactAuth

Record a press on an inbox item

Call it when the recipient presses the item or one of its buttons (`action_key`). Marks the item seen and read, records `interacted_at` and the key, and sends the `inbox_item.interacted` webhook so your backend can act on it (for example "Accept invite"). Repeating the same press changes nothing.

Path parameters

item_id*string · uuid

Id of the item.

Request body

action_keystring

The `action_key` of the button pressed; left out for a press on the item itself.

Example: "accept"

Response · 200 The item after the press.

id*string · uuid

The item id (time-ordered).

notification_id*string · uuid

The notification.

type*string

The notification type key.

category*string

The category key.

tenant*string

Tenant.

title*string

Rendered title.

body*string

Rendered body (Markdown subset).

action_url*string

Where a click goes.

avatar_url*string

Avatar URL.

actions*array

Up to 2 buttons.

actor*object

Who caused it.

data*object

The send's data, exactly as sent.

seen_at*string · date-time

Seen (the bell opened).

read_at*string · date-time

Read.

archived_at*string · date-time

Archived.

interacted_at*string · date-time

When the recipient first pressed the item or one of its buttons.

interaction_key*string

The `action_key` of the button pressed last (null for a press on the item itself).

retracted_at*string · date-time

Retracted by the sender.

created_at*string · date-time

Created.

Example

Request

POST https://api.notify.productcraft.co/v1/client/inbox/{item_id}/interact
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "action_key": "accept"
}

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "notification_id": "00000000-0000-0000-0000-000000000000",
  "type": "string",
  "category": "string",
  "tenant": "string",
  "title": "string",
  "body": "string",
  "action_url": "string",
  "avatar_url": "string",
  "actions": [
    {
      "label": "string",
      "url": "string",
      "action_key": "string"
    }
  ],
  "actor": {},
  "data": {},
  "seen_at": "2026-01-01T00:00:00.000Z",
  "read_at": "2026-01-01T00:00:00.000Z",
  "archived_at": "2026-01-01T00:00:00.000Z",
  "interacted_at": "2026-01-01T00:00:00.000Z",
  "interaction_key": "string",
  "retracted_at": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z"
}