WebhookController

Get a webhook results for a webhook

get/webhooks/{webhookId}/results

Request

  • Base URL: https://api.mailslurp.com
  • URL: https://api.mailslurp.com/webhooks/{webhookId}/results
  • Auth: API key in header x-api-key

Path parameters

webhookIdstring uuid required

ID of webhook to get results for

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

searchFilterstring

Optional search filter

sincestring date-time

Filter by created at after the given timestamp

beforestring date-time

Filter by created at before the given timestamp

unseenOnlyboolean

Filter for unseen exceptions only

resultType'BAD_RESPONSE' | 'EXCEPTION' | 'EXHAUSTED' | 'SUCCESS' | 'REDRIVEN'

Filter by result type

eventName'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'

Filter by event name

minStatusCodeinteger

Minimum response status

maxStatusCodeinteger

Maximum response status

inboxIdstring uuid

Inbox ID

smsIdstring uuid

Sms ID

attachmentIdstring uuid

Attachment ID

emailIdstring uuid

Email ID

phoneIdstring uuid

Phone ID

aiTransformerIdstring uuid

AI Transformer ID

Response

OK

Changes

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