SynapSynapDocs
Hub REST API

Proactive

The Proactive operations of the Hub REST API (1 operation).

For BuildersOpen-source podSynap CloudGenerated from Synap-core/backend@c31e261ab (main)

Post a proactive message into the user's feed channel

POST
/proactive/post

Authorization

bearerAuth
headerAuthorizationBearer <API key>

Pod API key (Bearer) issued via /api/hub/setup/agent or pod admin tooling. Browser/web clients may use the X-Session-Token header instead. See GET /api/hub/auth/status to introspect the calling key.

Request Body

application/json
  1. body
userId*string
workspaceId*string
content*string

Plaintext or markdown body. Max 10000 chars.

Lengthlength <= 10000
proactiveType*ProactiveType
Value in"insight""suggestion""alert""nudge""morning_briefing""weekly_digest""health_check"
reasoning?string
metadata?

Response Body

Delivery result (may be posted=false when rate-limited)

application/json
  1. response
posted*boolean
delivered?boolean
channelId?string
messageId?string
reason?string
detail?string
[key: string]?unknown
Example Request
curl -X POST 'https://pod.example.com/api/hub/proactive/post' \  -H 'Content-Type: application/json' \  -d '{  "userId": "string",  "workspaceId": "string",  "content": "string",  "proactiveType": "insight"}'
Example Response
{  "posted": true,  "delivered": true,  "channelId": "string",  "messageId": "string",  "reason": "string",  "detail": "string",  "property1": null,  "property2": null}

Playbooks

The Playbooks operations of the Hub REST API (5 operations).

Profiles

The Profiles operations of the Hub REST API (6 operations).