/v1/client/inbox/{item_id}/interactAuthRecord 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 · uuidId of the item.
Request body
action_keystringThe `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 · uuidThe item id (time-ordered).
notification_id*string · uuidThe notification.
type*stringThe notification type key.
category*stringThe category key.
tenant*stringTenant.
title*stringRendered title.
body*stringRendered body (Markdown subset).
action_url*stringWhere a click goes.
avatar_url*stringAvatar URL.
actions*arrayUp to 2 buttons.
actor*objectWho caused it.
data*objectThe send's data, exactly as sent.
seen_at*string · date-timeSeen (the bell opened).
read_at*string · date-timeRead.
archived_at*string · date-timeArchived.
interacted_at*string · date-timeWhen the recipient first pressed the item or one of its buttons.
interaction_key*stringThe `action_key` of the button pressed last (null for a press on the item itself).
retracted_at*string · date-timeRetracted by the sender.
created_at*string · date-timeCreated.
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"
}