Constructor Detail

• WebhookControllerApi

  WebhookControllerApi(String xApiKey, String basePath)

Method Detail

• getBaseUrl

   final String getBaseUrl()

• createWebhook

   final WebhookDto createWebhook(UUID inboxId, CreateWebhookOptions webhookOptions)

  Attach a WebHook URL to an inbox Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint.

  Parameters:

  inboxId - inboxId

  webhookOptions - webhookOptions

• createWebhookRequestConfig

   final RequestConfig createWebhookRequestConfig(UUID inboxId, CreateWebhookOptions webhookOptions)

  To obtain the request config of the operation createWebhook

  Parameters:

  inboxId - inboxId

  webhookOptions - webhookOptions

• deleteAllWebhooks

   final Unit deleteAllWebhooks()

  Delete all webhooks

• deleteAllWebhooksRequestConfig

   final RequestConfig deleteAllWebhooksRequestConfig()

  To obtain the request config of the operation deleteAllWebhooks

• deleteWebhook

   final Unit deleteWebhook(UUID inboxId, UUID webhookId)

  Delete and disable a Webhook for an Inbox

  Parameters:

  inboxId - inboxId

  webhookId - webhookId

• deleteWebhookRequestConfig

   final RequestConfig deleteWebhookRequestConfig(UUID inboxId, UUID webhookId)

  To obtain the request config of the operation deleteWebhook

  Parameters:

  inboxId - inboxId

  webhookId - webhookId

• getAllWebhookResults

   final PageWebhookResult getAllWebhookResults(OffsetDateTime before, Integer page, String searchFilter, OffsetDateTime since, Integer size, String sort, Boolean unseenOnly)

  Get results for all webhooks

  Parameters:

  before - Filter by created at before the given timestamp (optional)

  page - Optional page index in list pagination (optional, default to 0)

  searchFilter - Optional search filter (optional)

  since - Filter by created at after the given timestamp (optional)

  size - Optional page size in list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  unseenOnly - Filter for unseen exceptions only (optional)

• getAllWebhookResultsRequestConfig

   final RequestConfig getAllWebhookResultsRequestConfig(OffsetDateTime before, Integer page, String searchFilter, OffsetDateTime since, Integer size, String sort, Boolean unseenOnly)

  To obtain the request config of the operation getAllWebhookResults

  Parameters:

  before - Filter by created at before the given timestamp (optional)

  page - Optional page index in list pagination (optional, default to 0)

  searchFilter - Optional search filter (optional)

  since - Filter by created at after the given timestamp (optional)

  size - Optional page size in list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  unseenOnly - Filter for unseen exceptions only (optional)

• getAllWebhooks

   final PageWebhookProjection getAllWebhooks(OffsetDateTime before, Integer page, String searchFilter, OffsetDateTime since, Integer size, String sort)

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

  Parameters:

  before - Filter by created at before the given timestamp (optional)

  page - Optional page index in list pagination (optional, default to 0)

  searchFilter - Optional search filter (optional)

  since - Filter by created at after the given timestamp (optional)

  size - Optional page size for paginated result list.

  sort - Optional createdAt sort direction ASC or DESC (optional, default to DESC)

• getAllWebhooksRequestConfig

   final RequestConfig getAllWebhooksRequestConfig(OffsetDateTime before, Integer page, String searchFilter, OffsetDateTime since, Integer size, String sort)

  To obtain the request config of the operation getAllWebhooks

  Parameters:

  before - Filter by created at before the given timestamp (optional)

  page - Optional page index in list pagination (optional, default to 0)

  searchFilter - Optional search filter (optional)

  since - Filter by created at after the given timestamp (optional)

  size - Optional page size for paginated result list.

  sort - Optional createdAt sort direction ASC or DESC (optional, default to DESC)

• getInboxWebhooksPaginated

   final PageWebhookProjection getInboxWebhooksPaginated(UUID inboxId, OffsetDateTime before, Integer page, String searchFilter, OffsetDateTime since, Integer size, String sort)

  Get paginated webhooks for an Inbox

  Parameters:

  inboxId - inboxId

  before - Filter by created at before the given timestamp (optional)

  page - Optional page index in list pagination (optional, default to 0)

  searchFilter - Optional search filter (optional)

  since - Filter by created at after the given timestamp (optional)

  size - Optional page size in list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

• getInboxWebhooksPaginatedRequestConfig

   final RequestConfig getInboxWebhooksPaginatedRequestConfig(UUID inboxId, OffsetDateTime before, Integer page, String searchFilter, OffsetDateTime since, Integer size, String sort)

  To obtain the request config of the operation getInboxWebhooksPaginated

  Parameters:

  inboxId - inboxId

  before - Filter by created at before the given timestamp (optional)

  page - Optional page index in list pagination (optional, default to 0)

  searchFilter - Optional search filter (optional)

  since - Filter by created at after the given timestamp (optional)

  size - Optional page size in list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

• getJsonSchemaForWebhookPayload

   final JSONSchemaDto getJsonSchemaForWebhookPayload(UUID webhookId)

  Get JSON Schema definition for webhook payload

  Parameters:

  webhookId - webhookId

• getJsonSchemaForWebhookPayloadRequestConfig

   final RequestConfig getJsonSchemaForWebhookPayloadRequestConfig(UUID webhookId)

  To obtain the request config of the operation getJsonSchemaForWebhookPayload

  Parameters:

  webhookId - webhookId

• getTestWebhookPayload

   final AbstractWebhookPayload getTestWebhookPayload(String eventName)

  Get test webhook payload example. Response content depends on eventName passed. Uses `EMAIL_RECEIVED` as default.

  Parameters:

  eventName - eventName (optional)

• getTestWebhookPayloadRequestConfig

   final RequestConfig getTestWebhookPayloadRequestConfig(String eventName)

  To obtain the request config of the operation getTestWebhookPayload

  Parameters:

  eventName - eventName (optional)

• getTestWebhookPayloadEmailOpened

   final WebhookEmailOpenedPayload getTestWebhookPayloadEmailOpened()

  Get webhook test payload for email opened event

• getTestWebhookPayloadEmailOpenedRequestConfig

   final RequestConfig getTestWebhookPayloadEmailOpenedRequestConfig()

  To obtain the request config of the operation getTestWebhookPayloadEmailOpened

• getTestWebhookPayloadEmailRead

   final WebhookEmailReadPayload getTestWebhookPayloadEmailRead()

  Get webhook test payload for email opened event

• getTestWebhookPayloadEmailReadRequestConfig

   final RequestConfig getTestWebhookPayloadEmailReadRequestConfig()

  To obtain the request config of the operation getTestWebhookPayloadEmailRead

• getTestWebhookPayloadForWebhook

   final AbstractWebhookPayload getTestWebhookPayloadForWebhook(UUID webhookId)

  Get example payload for webhook

  Parameters:

  webhookId - webhookId

• getTestWebhookPayloadForWebhookRequestConfig

   final RequestConfig getTestWebhookPayloadForWebhookRequestConfig(UUID webhookId)

  To obtain the request config of the operation getTestWebhookPayloadForWebhook

  Parameters:

  webhookId - webhookId

• getTestWebhookPayloadNewAttachment

   final WebhookNewAttachmentPayload getTestWebhookPayloadNewAttachment()

  Get webhook test payload for new attachment event

• getTestWebhookPayloadNewAttachmentRequestConfig

   final RequestConfig getTestWebhookPayloadNewAttachmentRequestConfig()

  To obtain the request config of the operation getTestWebhookPayloadNewAttachment

• getTestWebhookPayloadNewContact

   final WebhookNewContactPayload getTestWebhookPayloadNewContact()

  Get webhook test payload for new contact event

• getTestWebhookPayloadNewContactRequestConfig

   final RequestConfig getTestWebhookPayloadNewContactRequestConfig()

  To obtain the request config of the operation getTestWebhookPayloadNewContact

• getTestWebhookPayloadNewEmail

   final WebhookNewEmailPayload getTestWebhookPayloadNewEmail()

  Get webhook test payload for new email event

• getTestWebhookPayloadNewEmailRequestConfig

   final RequestConfig getTestWebhookPayloadNewEmailRequestConfig()

  To obtain the request config of the operation getTestWebhookPayloadNewEmail

• getWebhook

   final WebhookDto getWebhook(UUID webhookId)

  Get a webhook for an Inbox

  Parameters:

  webhookId - webhookId

• getWebhookRequestConfig

   final RequestConfig getWebhookRequestConfig(UUID webhookId)

  To obtain the request config of the operation getWebhook

  Parameters:

  webhookId - webhookId

• getWebhookResult

   final WebhookResultDto getWebhookResult(UUID webhookResultId)

  Get a webhook result for a webhook

  Parameters:

  webhookResultId - Webhook Result ID

• getWebhookResultRequestConfig

   final RequestConfig getWebhookResultRequestConfig(UUID webhookResultId)

  To obtain the request config of the operation getWebhookResult

  Parameters:

  webhookResultId - Webhook Result ID

• getWebhookResults

   final PageWebhookResult getWebhookResults(UUID webhookId, OffsetDateTime before, Integer page, String searchFilter, OffsetDateTime since, Integer size, String sort, Boolean unseenOnly)

  Get a webhook results for a webhook

  Parameters:

  webhookId - ID of webhook to get results for

  before - Filter by created at before the given timestamp (optional)

  page - Optional page index in list pagination (optional, default to 0)

  searchFilter - Optional search filter (optional)

  since - Filter by created at after the given timestamp (optional)

  size - Optional page size in list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  unseenOnly - Filter for unseen exceptions only (optional)

• getWebhookResultsRequestConfig

   final RequestConfig getWebhookResultsRequestConfig(UUID webhookId, OffsetDateTime before, Integer page, String searchFilter, OffsetDateTime since, Integer size, String sort, Boolean unseenOnly)

  To obtain the request config of the operation getWebhookResults

  Parameters:

  webhookId - ID of webhook to get results for

  before - Filter by created at before the given timestamp (optional)

  page - Optional page index in list pagination (optional, default to 0)

  searchFilter - Optional search filter (optional)

  since - Filter by created at after the given timestamp (optional)

  size - Optional page size in list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  unseenOnly - Filter for unseen exceptions only (optional)

• getWebhookResultsUnseenErrorCount

   final UnseenErrorCountDto getWebhookResultsUnseenErrorCount(UUID inboxId)

  Get count of unseen webhook results with error status

  Parameters:

  inboxId - inboxId

• getWebhookResultsUnseenErrorCountRequestConfig

   final RequestConfig getWebhookResultsUnseenErrorCountRequestConfig(UUID inboxId)

  To obtain the request config of the operation getWebhookResultsUnseenErrorCount

  Parameters:

  inboxId - inboxId

• getWebhooks

   final List<WebhookDto> getWebhooks(UUID inboxId)

  Get all webhooks for an Inbox

  Parameters:

  inboxId - inboxId

• getWebhooksRequestConfig

   final RequestConfig getWebhooksRequestConfig(UUID inboxId)

  To obtain the request config of the operation getWebhooks

  Parameters:

  inboxId - inboxId

• redriveWebhookResult

   final WebhookRedriveResult redriveWebhookResult(UUID webhookResultId)

  Get a webhook result and try to resend the original webhook payload Allows you to resend a webhook payload that was already sent. Webhooks that fail are retried automatically for 24 hours and then put in a dead letter queue. You can retry results manually using this method.

  Parameters:

  webhookResultId - Webhook Result ID

• redriveWebhookResultRequestConfig

   final RequestConfig redriveWebhookResultRequestConfig(UUID webhookResultId)

  To obtain the request config of the operation redriveWebhookResult

  Parameters:

  webhookResultId - Webhook Result ID

• sendTestData

   final WebhookTestResult sendTestData(UUID webhookId)

  Send webhook test data

  Parameters:

  webhookId - webhookId

• sendTestDataRequestConfig

   final RequestConfig sendTestDataRequestConfig(UUID webhookId)

  To obtain the request config of the operation sendTestData

  Parameters:

  webhookId - webhookId