Sign in
Messages

List messages

Returns a paginated list of messages for the current environment.

get/v1/messages

Query parameters

afterstring

The cursor to fetch entries after.

beforestring

The cursor to fetch entries before.

page_sizeinteger

The number of items per page (defaults to 50).

tenantstring

Limits the results to items with the corresponding tenant.

channel_idstring

Limits the results to items with the corresponding channel ID.

status[]string[]

Limits the results to messages with the given delivery status.

engagement_status[]string[]

Limits the results to messages with the given engagement status.

message_ids[]string[]

Limits the results to only the message IDs given (max 50). Note: when using this option, the results will be subject to any other filters applied to the query.

workflow_categories[]string[]

Limits the results to messages related to any of the provided categories.

sourcestring

Limits the results to messages triggered by the given workflow key.

workflow_run_idstring uuid

Limits the results to messages associated with the top-level workflow run ID returned by the workflow trigger request.

workflow_recipient_run_idstring uuid

Limits the results to messages for a specific recipient's workflow run.

trigger_datastring

Limits the results to only messages that were generated with the given data. See trigger data filtering for more information.

inserted_at.gtestring

Limits the results to messages inserted after or on the given date.

inserted_at.ltestring

Limits the results to messages inserted before or on the given date.

inserted_at.gtstring

Limits the results to messages inserted after the given date.

inserted_at.ltstring

Limits the results to messages inserted before the given date.

Response

OK

Example response

{
  "items": [
    {
      "actors": [
        "mr_arnold",
        "mr_muldoon"
      ],
      "archived_at": null,
      "channel_id": "123e4567-e89b-12d3-a456-426614174000",
      "clicked_at": null,
      "data": {
        "affected_areas": [
          "visitor_center",
          "raptor_pen",
          "trex_paddock"
        ],
        "attraction_id": "paddock_rex_01",
        "evacuation_protocol": "active",
        "message": "Life finds a way",
        "severity": "critical",
        "system_status": "fences_failing"
      },
      "engagement_statuses": [
        "read",
        "seen"
      ],
      "id": "2w3YUpTTOxuDvZFji8OMsKrG176",
      "inserted_at": "1993-06-11T21:15:00Z",
      "interacted_at": null,
      "link_clicked_at": null,
      "metadata": {
        "incident_id": "shutdown-june-1993",
        "initiated_by": "ray_arnold",
        "priority": "critical"
      },
      "read_at": "1993-06-11T21:30:00Z",
      "recipients": "dr_grant",
      "scheduled_at": null,
      "seen_at": "1993-06-11T21:29:45Z",
      "source": {
        "__typename": "Workflow",
        "categories": [
          "security",
          "emergency"
        ],
        "key": "security-breach-alert",
        "step_ref": "alert_step_1",
        "version_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "status": "sent",
      "tenant": "ingen_isla_nublar",
      "updated_at": "1993-06-11T21:30:05Z",
      "workflow": "security-breach-alert"
    }
  ],
  "page_info": {
    "__typename": "PageInfo",
    "after": null,
    "before": null,
    "page_size": 25
  }
}

Changes