Agents

Read an in-app campaign and its stored authoring fields

Use an explicitly scoped user-bound account bearer credential or an application session. Scope grants are intersected with live membership, role, tenant isolation, agent access and plan limits; a credential does not grant an owner role. Invitation acceptance requires the verified recipient email.

get/workspaces/{workspaceId}/agents/{agentId}/in-app/{nudgeId}

Request

  • Base URL: https://app.communicate.so/api/v1
  • URL: https://app.communicate.so/api/v1/workspaces/{workspaceId}/agents/{agentId}/in-app/{nudgeId}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Secure-better-auth.session_token
    • API key in cookie better-auth.session_token

Path parameters

workspaceIdstring required
agentIdstring required
nudgeIdstring required

Response

Read an in-app campaign and its stored authoring fields

idstring required
workspaceIdstring required
agentIdstring required
namestring required
status'draft' | 'live' | 'paused' | 'archived' required
surface'floating_card' | 'in_panel' | 'toast' required
priorityinteger required
contentobject required
targetingobject required
frequency'once' | 'every_session' | 'always' required
delaySecondsinteger required
scheduledAtstring date-time nullable required
expiresAtstring date-time nullable required
publishedAtstring date-time nullable required
createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.