Subscriptions

GetSubscriptionNotificationEvents

Get subscription notification events

get/channel/{channelId}/subscription/notification-events

Request

  • Base URL
    https://api.cleverpush.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

channelIdstring required

The channel ID.

Query parameters

subscriptionIdstring required

The subscription ID to fetch events for. Location: query parameter. Required.

notificationIdstring

Optional. When set, restricts results to this notification ID only. When omitted, events for all notifications of the subscription are returned.

typestring

Filter by a specific event type (e.g. 'delivered', 'inAppDelivered', 'clicked', 'opened', 'softBounce', 'hardBounce', 'emailSpamComplained', 'tagAdded', 'tagRemoved', 'topicAdded', 'topicRemoved', 'segmentAdded', 'segmentRemoved', 'voucherCodeSent', 'uniqueClickedLinks'). If omitted, all types are returned.

limitstring

Number of events per page. Default: 100.

pageTokenstring

Pagination token from a previous response to fetch the next page.

fieldsstring[]

Optional query parameter. Select response fields for each event. If omitted, the default full event response is returned. Supported event fields: subscriptionId, notificationId, type, payload, date. Additional notification fields available on request: subject, notificationTitle, notificationText, templateId, templateName.

Response

Success-Response:

pageTokenstring
<p>Pagination token for the next page. Only present when more results are available.</p>

Changes

No recorded changes to this operation across all 3 revisions of this API.