-
public final class WebhookControllerApi extends ApiClient
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classWebhookControllerApi.Companion
-
Constructor Summary
Constructors Constructor Description WebhookControllerApi(String xApiKey, String basePath)
-
Method Summary
Modifier and Type Method Description final StringgetBaseUrl()final WebhookDtocreateWebhook(UUID inboxId, CreateWebhookOptions createWebhookOptions)Attach a WebHook URL to an inbox Get notified whenever an inbox receives an email via a WebHook URL. final RequestConfigcreateWebhookRequestConfig(UUID inboxId, CreateWebhookOptions createWebhookOptions)To obtain the request config of the operation createWebhook final UnitdeleteAllWebhooks()Delete all webhooks final RequestConfigdeleteAllWebhooksRequestConfig()To obtain the request config of the operation deleteAllWebhooks final UnitdeleteWebhook(UUID inboxId, UUID webhookId)Delete and disable a Webhook for an Inbox final RequestConfigdeleteWebhookRequestConfig(UUID inboxId, UUID webhookId)To obtain the request config of the operation deleteWebhook final PageWebhookResultgetAllWebhookResults(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, Boolean unseenOnly)Get results for all webhooks final RequestConfiggetAllWebhookResultsRequestConfig(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, Boolean unseenOnly)To obtain the request config of the operation getAllWebhookResults final PageWebhookProjectiongetAllWebhooks(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before)List Webhooks Paginated List webhooks in paginated form. final RequestConfiggetAllWebhooksRequestConfig(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before)To obtain the request config of the operation getAllWebhooks final PageWebhookProjectiongetInboxWebhooksPaginated(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before)Get paginated webhooks for an Inbox final RequestConfiggetInboxWebhooksPaginatedRequestConfig(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before)To obtain the request config of the operation getInboxWebhooksPaginated final JSONSchemaDtogetJsonSchemaForWebhookPayload(UUID webhookId)Get JSON Schema definition for webhook payload final RequestConfiggetJsonSchemaForWebhookPayloadRequestConfig(UUID webhookId)To obtain the request config of the operation getJsonSchemaForWebhookPayload final AbstractWebhookPayloadgetTestWebhookPayload(String eventName)Get test webhook payload example. final RequestConfiggetTestWebhookPayloadRequestConfig(String eventName)To obtain the request config of the operation getTestWebhookPayload final WebhookEmailOpenedPayloadgetTestWebhookPayloadEmailOpened()Get webhook test payload for email opened event final RequestConfiggetTestWebhookPayloadEmailOpenedRequestConfig()To obtain the request config of the operation getTestWebhookPayloadEmailOpened final WebhookEmailReadPayloadgetTestWebhookPayloadEmailRead()Get webhook test payload for email opened event final RequestConfiggetTestWebhookPayloadEmailReadRequestConfig()To obtain the request config of the operation getTestWebhookPayloadEmailRead final AbstractWebhookPayloadgetTestWebhookPayloadForWebhook(UUID webhookId)Get example payload for webhook final RequestConfiggetTestWebhookPayloadForWebhookRequestConfig(UUID webhookId)To obtain the request config of the operation getTestWebhookPayloadForWebhook final WebhookNewAttachmentPayloadgetTestWebhookPayloadNewAttachment()Get webhook test payload for new attachment event final RequestConfiggetTestWebhookPayloadNewAttachmentRequestConfig()To obtain the request config of the operation getTestWebhookPayloadNewAttachment final WebhookNewContactPayloadgetTestWebhookPayloadNewContact()Get webhook test payload for new contact event final RequestConfiggetTestWebhookPayloadNewContactRequestConfig()To obtain the request config of the operation getTestWebhookPayloadNewContact final WebhookNewEmailPayloadgetTestWebhookPayloadNewEmail()Get webhook test payload for new email event final RequestConfiggetTestWebhookPayloadNewEmailRequestConfig()To obtain the request config of the operation getTestWebhookPayloadNewEmail final WebhookDtogetWebhook(UUID webhookId)Get a webhook for an Inbox final RequestConfiggetWebhookRequestConfig(UUID webhookId)To obtain the request config of the operation getWebhook final WebhookResultDtogetWebhookResult(UUID webhookResultId)Get a webhook result for a webhook final RequestConfiggetWebhookResultRequestConfig(UUID webhookResultId)To obtain the request config of the operation getWebhookResult final PageWebhookResultgetWebhookResults(UUID webhookId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, Boolean unseenOnly)Get a webhook results for a webhook final RequestConfiggetWebhookResultsRequestConfig(UUID webhookId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, Boolean unseenOnly)To obtain the request config of the operation getWebhookResults final UnseenErrorCountDtogetWebhookResultsUnseenErrorCount(UUID inboxId)Get count of unseen webhook results with error status final RequestConfiggetWebhookResultsUnseenErrorCountRequestConfig(UUID inboxId)To obtain the request config of the operation getWebhookResultsUnseenErrorCount final List<WebhookDto>getWebhooks(UUID inboxId)Get all webhooks for an Inbox final RequestConfiggetWebhooksRequestConfig(UUID inboxId)To obtain the request config of the operation getWebhooks final WebhookRedriveResultredriveWebhookResult(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. final RequestConfigredriveWebhookResultRequestConfig(UUID webhookResultId)To obtain the request config of the operation redriveWebhookResult final WebhookTestResultsendTestData(UUID webhookId)Send webhook test data final RequestConfigsendTestDataRequestConfig(UUID webhookId)To obtain the request config of the operation sendTestData -
-
Method Detail
-
getBaseUrl
final String getBaseUrl()
-
createWebhook
final WebhookDto createWebhook(UUID inboxId, CreateWebhookOptions createWebhookOptions)
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.
-
createWebhookRequestConfig
final RequestConfig createWebhookRequestConfig(UUID inboxId, CreateWebhookOptions createWebhookOptions)
To obtain the request config of the operation createWebhook
-
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
-
deleteWebhookRequestConfig
final RequestConfig deleteWebhookRequestConfig(UUID inboxId, UUID webhookId)
To obtain the request config of the operation deleteWebhook
-
getAllWebhookResults
final PageWebhookResult getAllWebhookResults(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, Boolean unseenOnly)
Get results for all webhooks
- 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)searchFilter- Optional search filter (optional)since- Filter by created at after the given timestamp (optional)before- Filter by created at before the given timestamp (optional)unseenOnly- Filter for unseen exceptions only (optional)
-
getAllWebhookResultsRequestConfig
final RequestConfig getAllWebhookResultsRequestConfig(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, Boolean unseenOnly)
To obtain the request config of the operation getAllWebhookResults
- 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)searchFilter- Optional search filter (optional)since- Filter by created at after the given timestamp (optional)before- Filter by created at before the given timestamp (optional)unseenOnly- Filter for unseen exceptions only (optional)
-
getAllWebhooks
final PageWebhookProjection getAllWebhooks(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before)
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 for paginated result list.sort- Optional createdAt sort direction ASC or DESC (optional, default to DESC)searchFilter- Optional search filter (optional)since- Filter by created at after the given timestamp (optional)before- Filter by created at before the given timestamp (optional)
-
getAllWebhooksRequestConfig
final RequestConfig getAllWebhooksRequestConfig(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before)
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 for paginated result list.sort- Optional createdAt sort direction ASC or DESC (optional, default to DESC)searchFilter- Optional search filter (optional)since- Filter by created at after the given timestamp (optional)before- Filter by created at before the given timestamp (optional)
-
getInboxWebhooksPaginated
final PageWebhookProjection getInboxWebhooksPaginated(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before)
Get paginated webhooks for an Inbox
- 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)searchFilter- Optional search filter (optional)since- Filter by created at after the given timestamp (optional)before- Filter by created at before the given timestamp (optional)
-
getInboxWebhooksPaginatedRequestConfig
final RequestConfig getInboxWebhooksPaginatedRequestConfig(UUID inboxId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before)
To obtain the request config of the operation getInboxWebhooksPaginated
- 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)searchFilter- Optional search filter (optional)since- Filter by created at after the given timestamp (optional)before- Filter by created at before the given timestamp (optional)
-
getJsonSchemaForWebhookPayload
final JSONSchemaDto getJsonSchemaForWebhookPayload(UUID webhookId)
Get JSON Schema definition for webhook payload
-
getJsonSchemaForWebhookPayloadRequestConfig
final RequestConfig getJsonSchemaForWebhookPayloadRequestConfig(UUID webhookId)
To obtain the request config of the operation getJsonSchemaForWebhookPayload
-
getTestWebhookPayload
final AbstractWebhookPayload getTestWebhookPayload(String eventName)
Get test webhook payload example. Response content depends on eventName passed. Uses `EMAIL_RECEIVED` as default.
- Parameters:
eventName- (optional)
-
getTestWebhookPayloadRequestConfig
final RequestConfig getTestWebhookPayloadRequestConfig(String eventName)
To obtain the request config of the operation getTestWebhookPayload
- Parameters:
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
-
getTestWebhookPayloadForWebhookRequestConfig
final RequestConfig getTestWebhookPayloadForWebhookRequestConfig(UUID webhookId)
To obtain the request config of the operation getTestWebhookPayloadForWebhook
-
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
-
getWebhookRequestConfig
final RequestConfig getWebhookRequestConfig(UUID webhookId)
To obtain the request config of the operation getWebhook
-
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, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, Boolean unseenOnly)
Get a webhook results for a webhook
- Parameters:
webhookId- ID of webhook to get results forpage- 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)searchFilter- Optional search filter (optional)since- Filter by created at after the given timestamp (optional)before- Filter by created at before the given timestamp (optional)unseenOnly- Filter for unseen exceptions only (optional)
-
getWebhookResultsRequestConfig
final RequestConfig getWebhookResultsRequestConfig(UUID webhookId, Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, Boolean unseenOnly)
To obtain the request config of the operation getWebhookResults
- Parameters:
webhookId- ID of webhook to get results forpage- 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)searchFilter- Optional search filter (optional)since- Filter by created at after the given timestamp (optional)before- Filter by created at before the given timestamp (optional)unseenOnly- Filter for unseen exceptions only (optional)
-
getWebhookResultsUnseenErrorCount
final UnseenErrorCountDto getWebhookResultsUnseenErrorCount(UUID inboxId)
Get count of unseen webhook results with error status
-
getWebhookResultsUnseenErrorCountRequestConfig
final RequestConfig getWebhookResultsUnseenErrorCountRequestConfig(UUID inboxId)
To obtain the request config of the operation getWebhookResultsUnseenErrorCount
-
getWebhooks
final List<WebhookDto> getWebhooks(UUID inboxId)
Get all webhooks for an Inbox
-
getWebhooksRequestConfig
final RequestConfig getWebhooksRequestConfig(UUID inboxId)
To obtain the request config of the operation getWebhooks
-
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
-
sendTestDataRequestConfig
final RequestConfig sendTestDataRequestConfig(UUID webhookId)
To obtain the request config of the operation sendTestData
-
-
-
-