Documentation | Messages › List Delivery Logs

Messages

messages

Methods

Archive Message ->

Message

put/v1/messages/{message_id}/archived

Archive message

Get Message ->

Message

get/v1/messages/{message_id}

Get message

Get Message Content -> { __typename, data, inserted_at, 1 more... }

get/v1/messages/{message_id}/content

Returns the fully rendered contents of a message, where the response depends on the channel the message was sent on.

List Messages -> EntriesCursor<

Message

get/v1/messages

List messages

Parameters

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/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 Activities -> ItemsCursor<

Activity

get/v1/messages/{message_id}/activities

List activities

List Delivery Logs -> EntriesCursor<

MessageDeliveryLog

get/v1/messages/{message_id}/delivery_logs

List delivery logs

Parameters

message_id: 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<

MessageDeliveryLog

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

The information about a paginated result

Request example

curl https://api.knock.app/v1/messages/$MESSAGE_ID/delivery_logs \
    -H "Authorization: Bearer $KNOCK_API_KEY"

200Example

{
  "entries": [
    {
      "id": "2FVHPWxRqNuXQ9krvNP5A6Z4qXe",
      "__typename": "MessageDeliveryLog",
      "environment_id": "123e4567-e89b-12d3-a456-426614174000",
      "inserted_at": "2021-01-01T00:00:00Z",
      "request": {
        "body": {
          "html_content": "bar"
        },
        "headers": {
          "Content-Type": "bar"
        },
        "host": "localhost",
        "method": "GET",
        "path": "/",
        "query": "?foo=bar"
      },
      "response": {
        "body": {
          "success": "bar"
        },
        "headers": {
          "Content-Type": "bar"
        },
        "status": 200
      },
      "service_name": "Postmark"
    }
  ],
  "page_info": {
    "__typename": "PageInfo",
    "page_size": 25,
    "after": null,
    "before": null
  }
}