WebhookController

List Webhooks Paginated

List webhooks in paginated form. Allows for page index, page size, and sort direction.

get/webhooks/paginated

Request

  • Base URL: https://api.mailslurp.com
  • URL: https://api.mailslurp.com/webhooks/paginated
  • Auth: API key in header x-api-key

Query parameters

pageinteger

Optional page index in list pagination

sizeinteger

Optional page size for paginated result list.

sort'ASC' | 'DESC'

Optional createdAt sort direction ASC or DESC

searchFilterstring

Optional search filter

sincestring date-time

Filter by created at after the given timestamp

inboxIdstring uuid

Filter by inboxId

aiTransformerIdstring uuid

Filter by aiTransformerId

phoneIdstring uuid

Filter by phoneId

beforestring date-time

Filter by created at before the given timestamp

health'HEALTHY' | 'UNHEALTHY'

Filter by webhook health

eventType'EMAIL_RECEIVED' | 'NEW_AI_TRANSFORM_RESULT' | 'NEW_EMAIL' | 'NEW_CONTACT' | 'NEW_ATTACHMENT' | 'EMAIL_OPENED' | 'EMAIL_READ' | 'DELIVERY_STATUS' | 'BOUNCE' | 'BOUNCE_RECIPIENT' | 'NEW_SMS' | 'NEW_GUEST_USER'

Optional event type

urlstring

Optional url endpoint filter

eventTypeSource'INBOX' | 'PHONE' | 'AI_TRANSFORMER'

Webhook source type category such as phone, inbox, aiTranformer

includeAccountWideboolean

Include account scope webhooks when passing phoneId, inboxId, or aiTransformerId filters

Response

OK

Changes

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