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

• 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

• getAllWebhooks

   final PageWebhookProjection getAllWebhooks(Integer page, Integer size, String sort)

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

  Parameters:

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

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

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

• getAllWebhooksRequestConfig

   final RequestConfig getAllWebhooksRequestConfig(Integer page, Integer size, String sort)

  To obtain the request config of the operation getAllWebhooks

  Parameters:

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

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

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

• 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)

• 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

• 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

• 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