Webhooks V2

Get all notifications by webhook id

Get all notifications by webhook id (paginated)

get/webhooks/{webhookId}/notifications

Request

Path parameters

webhookIdstring uuid required
Example:44fcead0-7053-4831-a53a-df7fb90d440f

Query parameters

order'ASC' | 'DESC'
Example:ASC

ASC / DESC ordering (default DESC)

sortBy'id' | 'createdAt' | 'updatedAt' | 'status' | 'eventType' | 'resourceId'
Example:id

Sort by field

pageCursorstring

Cursor of the required page

pageSizenumber
Example:10

Maximum number of items in the page

startTimenumber
Example:1625097600000

Start time in milliseconds since epoch to filter by notifications created after this time (default 31 days ago)

endTimenumber
Example:1625017600000

End time in milliseconds since epoch to filter by notifications created before this time (default current time)

statusesNotificationStatus[]

List of notification statuses to filter by

[
  "COMPLETED"
]
eventsWebhookEvent[]

List of webhook event types to filter by

resourceIdstring
Example:44fcead0-7053-4831-a53a-df7fb90d440f

Resource ID to filter by

Response

A paginated response containing NotificationExternalDTO objects

totalnumber nullable

The total number of notifications after all filters applied (not returned when 'pageCursor' parameter is used)

nextstring nullable

The ID of the next page

Example response

{
  "data": [
    {
      "id": "44fcead0-7053-4831-a53a-df7fb90d440f",
      "createdAt": 1625126400000,
      "updatedAt": 1625126400000,
      "status": "COMPLETED",
      "resourceId": "44fcead0-7053-4831-a53a-df7fb90d440f"
    }
  ],
  "total": 100,
  "next": "eJ0eXAiOiJKV1QiLCJhbGcOiJIUzI1NiJ9"
}

Changes

No recorded changes to this operation across all 1 revision of this API.