Stream-Events

Get all stream event templates

Changed on Nov 3, 2026

List all event templates in your account. Approved WhatsApp templates are synced from Meta before the list is returned.

Pagination. page (1-based, default 1) and itemsPerPage (default 30, at most 1000). The response is a plain JSON array.

Authentication: TextPeak API key in the Authorization header (see Authentication in the API Overview).

get/stream_events

Request

Base URL
https://api.commpeak.com/textpeak
URL
https://api.commpeak.com/textpeak/stream_events
Auth
API key in header Authorization

Query parameters

pageinteger nullable

Page number (1-based).

itemsPerPageinteger nullable

Items per page, at most 1000.

order[id]'asc' | 'desc'

Sort by ID.

idinteger nullable

Exact template ID.

streaminteger nullable

Only templates of this stream ID.

eventKeystring nullable

Exact event key.

Delivery channel contains this text.

Response

Successful Response

idinteger required

Unique template identifier.

namestring required

Template name.

textstring required

Template body with [placeholder] tokens. 4-byte characters (emoji) are removed on save.

eventKeystring required

Key used to trigger this template on the send endpoints (event). EVENT_<id> when saved empty.

createdAtstring required

When the template was created. Format YYYY-MM-DD HH:MM:SS.

activatedboolean required

Whether the template is active.

externalStatusstring nullable

Provider-side approval status (for example a WhatsApp template review).

languagestring nullable

Template language code. Always en for SMS templates.

sectionsunknown

variablesMappingunknown required

identifierstring nullable

External (provider) template identifier.

categorystring nullable

External (provider) template category.

Example response

[
  {
    "activated": true,
    "createdAt": "2026-03-01 09:00:00",
    "eventKey": "verification_code",
    "id": 21,
    "language": "en",
    "name": "Verification code",
    "provider": "sms",
    "sections": [
      "Your CommPeak code is [code]"
    ],
    "stream": {
      "id": 5,
      "name": "Marketing US"
    },
    "text": "Your CommPeak code is [code]",
    "variablesMapping": {}
  }
]

Changes

Nov 3, 20265012671cf95d Revision changes
- breaking
  for the query request parameter itemsPerPage, default value 30 was added
- breaking
  response property items/category list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property items/externalStatus list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property items/identifier list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property items/language list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  the / response's property type changed from array to no type for status
- breaking
  the / response's property type changed from object to no type for status
- breaking
  the / response's property type changed from array to no type for status
- warning
  deleted the query request parameter _page
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  added the new email enum value to the / response property for the response status
- warning
  added the new sms enum value to the / response property for the response status
- warning
  added the new telegram_bot enum value to the / response property for the response status
- warning
  added the new telegram_private enum value to the / response property for the response status
- warning
  added the new voice enum value to the / response property for the response status
- warning
  added the new websocket enum value to the / response property for the response status
- warning
  added the new whatsapp_business enum value to the / response property for the response status
- warning
  added the new whatsapp_private enum value to the / response property for the response status
- info
  api operation id getAllStreamEventTemplates removed and replaced with list_stream_events
- info
  the endpoint scheme security APIKeyHeader was added to the API
- info
  api tag Stream-Events added
- info
  api tag Stream event templates removed
- info
  added the new optional query request parameter eventKey
- info
  added the new optional query request parameter id
- info
  added the new optional query request parameter order[id]
- info
  added the new optional query request parameter page
- info
  added the new optional query request parameter provider
- info
  added the new optional query request parameter stream
- info
  query request parameter itemsPerPage list-of-types was widened by adding types null
- info
  for the query request parameter itemsPerPage, the type was generalized from integer to no type
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added subschema #2 to the / response property anyOf list for the response status
- info
  added subschema #1 subschema #2 to the / response property anyOf list for the response status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status

Operation history