Retrieve Messages by Subscription ID

get

https://{hostname}/webhooks/v3/subscriptions/{subscription-id}/messages

This operation returns a paginated list of messages for a subscription by subscription ID, date range, and a status such as failed or all.

Path Params

subscription-id

string

required

An identifier for a subscription. Only messages associated with the specified subscription ID are returned.

Query Params

since-date-time

date-time

required

The start date and time in UTC format. Must be before until-date-time.

until-date-time

date-time

The end date and time in UTC format. Must be within 2 weeks of since-date-time. If omitted, until-date-time defaults to 1 day after since-date-time.

count

integer

Defaults to 100

The pagination count, which represents the number of results to return per page.

page-token

string

A token used in stateful, cursor-based pagination that allows you to fetch a unique result set using pagination-current-token for the current page of results and pagination-next-token for the next page of results. When pagination-next-token is not provided, the current page is the last page of results.

status

string

Defaults to failed

Headers

Authorization

string

required

A bearer token for authentication.

global-tenant-id

string

A global identifier for a tenant.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200List of messages

400Bad Request

401Unable to authenticate the request.

404Subscription or messages not found

500Internal server error.