Documentation | Objects › List Messages

Objects

objects

Methods

Add Subscriptions -> Array<

Subscription

post/v1/objects/{collection}/{object_id}/subscriptions

Add subscriptions for an object. If a subscription already exists, it will be updated.

Delete An Object -> string

delete/v1/objects/{collection}/{object_id}

Delete an object

Delete Subscriptions -> Array<

Subscription

delete/v1/objects/{collection}/{object_id}/subscriptions

Delete subscriptions

Get An Object ->

Object

get/v1/objects/{collection}/{object_id}

Get an object

Get Channel Data ->

ChannelData

get/v1/objects/{collection}/{object_id}/channel_data/{channel_id}

Get channel data

Get A Preference Set ->

PreferenceSet

get/v1/objects/{collection}/{object_id}/preferences/{preference_set_id}

Get a preference set

List Objects In A Collection -> EntriesCursor<

Object

get/v1/objects/{collection}

List objects in a collection

Parameters

collection: string

after: string

Optional

The cursor to fetch entries after

before: string

Optional

The cursor to fetch entries before

page_size: number

Optional

The page size to fetch

Response fields

entries: Array<

Object

The list of objects

page_info: { __typename, page_size, after, 1 more... }

The information about a paginated result

Request example

curl https://api.knock.app/v1/objects/$COLLECTION \
    -H "Authorization: Bearer $KNOCK_API_KEY"

200Example

{
  "entries": [
    {
      "id": "project_1",
      "__typename": "Object",
      "collection": "projects",
      "updated_at": "2024-05-22T12:00:00Z",
      "created_at": null
    }
  ],
  "page_info": {
    "__typename": "PageInfo",
    "page_size": 25,
    "after": null,
    "before": null
  }
}

List Messages -> EntriesCursor<

Message

get/v1/objects/{collection}/{object_id}/messages

List messages

Parameters

collection: string

object_id: string

after: string

Optional

The cursor to fetch entries after

before: string

Optional

The cursor to fetch entries before

channel_id: string

Optional

The channel ID

engagement_status: Array<

Optional

The engagement status of the message

"seen"

"read"

"interacted"

"link_clicked"

"archived"

message_ids: Array<string>

Optional

The message IDs to filter messages by

page_size: number

Optional

The page size to fetch

source: string

Optional

The source of the message (workflow key)

status: Array<

Optional

The status of the message

"queued"

"sent"

"delivered"

"delivery_attempted"

"undelivered"

"not_sent"

"bounced"

tenant: string

Optional

The tenant ID

trigger_data: string

Optional

The trigger data to filter messages by. Must be a valid JSON object.

workflow_categories: Array<string>

Optional

The workflow categories to filter messages by

workflow_recipient_run_id: string

Optional

(format: uuid)

The workflow recipient run ID to filter messages by

workflow_run_id: string

Optional

(format: uuid)

The workflow run ID to filter messages by

Response fields

entries: Array<

Message

The list of messages

page_info: { __typename, page_size, after, 1 more... }

The information about a paginated result

Request example

curl https://api.knock.app/v1/objects/$COLLECTION/$OBJECT_ID/messages \
    -H "Authorization: Bearer $KNOCK_API_KEY"

200Example

{
  "entries": [
    {
      "id": "1jNaXzB2RZX3LY8wVQnfCKyPnv7",
      "__typename": "Message",
      "actors": [
        "user_123"
      ],
      "archived_at": null,
      "channel_id": "123e4567-e89b-12d3-a456-426614174000",
      "clicked_at": null,
      "data": {
        "foo": "bar"
      },
      "engagement_statuses": [
        "seen",
        "read"
      ],
      "inserted_at": "2021-01-01T00:00:00Z",
      "interacted_at": null,
      "link_clicked_at": null,
      "metadata": {
        "external_id": "bar"
      },
      "read_at": null,
      "recipient": "user_123",
      "scheduled_at": null,
      "seen_at": null,
      "source": {
        "__typename": "NotificationSource",
        "categories": [
          "collaboration"
        ],
        "key": "comment-created",
        "version_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "status": "queued",
      "tenant": "tenant_123",
      "updated_at": "2021-01-01T00:00:00Z",
      "workflow": "comment-created"
    }
  ],
  "page_info": {
    "__typename": "PageInfo",
    "page_size": 25,
    "after": null,
    "before": null
  }
}

List Schedules -> EntriesCursor<

Schedule

get/v1/objects/{collection}/{object_id}/schedules

List schedules

List Subscriptions -> EntriesCursor<

Subscription

get/v1/objects/{collection}/{object_id}/subscriptions

List subscriptions for an object. Either list all subscriptions that belong to the object, or all subscriptions that this object has. Determined by the mode query parameter.

Set Identify An Object ->

Object

put/v1/objects/{collection}/{object_id}

Set (identify) an object

Set Channel Data ->

ChannelData

put/v1/objects/{collection}/{object_id}/channel_data/{channel_id}

Set channel data

Update A Preference Set ->

PreferenceSet

put/v1/objects/{collection}/{object_id}/preferences/{preference_set_id}

Update a preference set