WebhookController

Get paginated webhooks for a phone number

get/phone/numbers/{phoneId}/webhooks/paginated

Request

  • Base URL: https://api.mailslurp.com
  • URL: https://api.mailslurp.com/phone/numbers/{phoneId}/webhooks/paginated
  • Auth: API key in header x-api-key

Path parameters

phoneIdstring uuid required

Query parameters

pageinteger

Optional page index in list pagination

sizeinteger

Optional page size in list pagination

sort'ASC' | 'DESC'

Optional createdAt sort direction ASC or DESC

sincestring date-time

Filter by created at after the given timestamp

beforestring date-time

Filter by created at before the given timestamp

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

searchFilterstring

Optional search filter

health'HEALTHY' | 'UNHEALTHY'

Filter by webhook health

includeAccountWideboolean

Include account scope phone webhooks

Response

OK

Changes

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