Interface IWebhookControllerApiSync

Represents a collection of functions to interact with the API endpoints

Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IWebhookControllerApiSync : IApiAccessor

Methods

View Source

CreateAccountWebhook(CreateWebhookOptions, int)

Attach a WebHook URL to an inbox

Declaration
WebhookDto CreateAccountWebhook(CreateWebhookOptions createWebhookOptions, int operationIndex = 0)
Parameters
Type Name Description
CreateWebhookOptions createWebhookOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
WebhookDto

WebhookDto
Remarks

Get notified of account level events such as bounce and bounce recipient.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateAccountWebhookWithHttpInfo(CreateWebhookOptions, int)

Attach a WebHook URL to an inbox

Declaration
ApiResponse<WebhookDto> CreateAccountWebhookWithHttpInfo(CreateWebhookOptions createWebhookOptions, int operationIndex = 0)
Parameters
Type Name Description
CreateWebhookOptions createWebhookOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<WebhookDto>

ApiResponse of WebhookDto
Remarks

Get notified of account level events such as bounce and bounce recipient.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateWebhook(Guid, CreateWebhookOptions, int)

Attach a WebHook URL to an inbox

Declaration
WebhookDto CreateWebhook(Guid inboxId, CreateWebhookOptions createWebhookOptions, int operationIndex = 0)
Parameters
Type Name Description
System.Guid inboxId
CreateWebhookOptions createWebhookOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
WebhookDto

WebhookDto
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateWebhookForPhoneNumber(Guid, CreateWebhookOptions, int)

Attach a WebHook URL to a phone number

Declaration
WebhookDto CreateWebhookForPhoneNumber(Guid phoneNumberId, CreateWebhookOptions createWebhookOptions, int operationIndex = 0)
Parameters
Type Name Description
System.Guid phoneNumberId
CreateWebhookOptions createWebhookOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
WebhookDto

WebhookDto
Remarks

Get notified whenever a phone number receives an SMS via a WebHook URL.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateWebhookForPhoneNumberWithHttpInfo(Guid, CreateWebhookOptions, int)

Attach a WebHook URL to a phone number

Declaration
ApiResponse<WebhookDto> CreateWebhookForPhoneNumberWithHttpInfo(Guid phoneNumberId, CreateWebhookOptions createWebhookOptions, int operationIndex = 0)
Parameters
Type Name Description
System.Guid phoneNumberId
CreateWebhookOptions createWebhookOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<WebhookDto>

ApiResponse of WebhookDto
Remarks

Get notified whenever a phone number receives an SMS via a WebHook URL.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateWebhookWithHttpInfo(Guid, CreateWebhookOptions, int)

Attach a WebHook URL to an inbox

Declaration
ApiResponse<WebhookDto> CreateWebhookWithHttpInfo(Guid inboxId, CreateWebhookOptions createWebhookOptions, int operationIndex = 0)
Parameters
Type Name Description
System.Guid inboxId
CreateWebhookOptions createWebhookOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<WebhookDto>

ApiResponse of WebhookDto
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteAllWebhooks(DateTime?, int)

Delete all webhooks

Declaration
void DeleteAllWebhooks(DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
DateTime? before

before (optional)
int operationIndex

Index associated with the operation.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteAllWebhooksWithHttpInfo(DateTime?, int)

Delete all webhooks

Declaration
ApiResponse<object> DeleteAllWebhooksWithHttpInfo(DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
DateTime? before

before (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<object>

ApiResponse of Object(void)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteWebhook(Guid, Guid, int)

Delete and disable a Webhook for an Inbox

Declaration
void DeleteWebhook(Guid inboxId, Guid webhookId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid inboxId
System.Guid webhookId
int operationIndex

Index associated with the operation.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteWebhookById(Guid, int)

Delete a webhook

Declaration
void DeleteWebhookById(Guid webhookId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid webhookId
int operationIndex

Index associated with the operation.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteWebhookByIdWithHttpInfo(Guid, int)

Delete a webhook

Declaration
ApiResponse<object> DeleteWebhookByIdWithHttpInfo(Guid webhookId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid webhookId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<object>

ApiResponse of Object(void)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteWebhookWithHttpInfo(Guid, Guid, int)

Delete and disable a Webhook for an Inbox

Declaration
ApiResponse<object> DeleteWebhookWithHttpInfo(Guid inboxId, Guid webhookId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid inboxId
System.Guid webhookId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<object>

ApiResponse of Object(void)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAllAccountWebhooks(int?, int?, string, string, DateTime?, DateTime?, int)

List account webhooks Paginated

Declaration
PageWebhookProjection GetAllAccountWebhooks(int? page = null, int? size = null, string sort = null, string eventType = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
int? page

Optional page index in list pagination (optional, default to 0)
int? size

Optional page size for paginated result list. (optional, default to 20)
string sort

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

Optional event type (optional)
DateTime? since

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageWebhookProjection

PageWebhookProjection
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAllAccountWebhooksWithHttpInfo(int?, int?, string, string, DateTime?, DateTime?, int)

List account webhooks Paginated

Declaration
ApiResponse<PageWebhookProjection> GetAllAccountWebhooksWithHttpInfo(int? page = null, int? size = null, string sort = null, string eventType = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
int? page

Optional page index in list pagination (optional, default to 0)
int? size

Optional page size for paginated result list. (optional, default to 20)
string sort

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

Optional event type (optional)
DateTime? since

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PageWebhookProjection>

ApiResponse of PageWebhookProjection
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAllWebhookResults(int?, int?, string, string, DateTime?, DateTime?, bool?, string, string, int?, int?, Guid?, Guid?, Guid?, Guid?, Guid?, int)

Get results for all webhooks

Declaration
PageWebhookResult GetAllWebhookResults(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? unseenOnly = null, string resultType = null, string eventName = null, int? minStatusCode = null, int? maxStatusCode = null, Guid? inboxId = null, Guid? smsId = null, Guid? attachmentId = null, Guid? emailId = null, Guid? phoneId = null, int operationIndex = 0)
Parameters
Type Name Description
int? page

Optional page index in list pagination (optional, default to 0)
int? size

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

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

Optional search filter (optional)
DateTime? since

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
bool? unseenOnly

Filter for unseen exceptions only (optional)
string resultType

Filter by result type (optional)
string eventName

Filter by event name (optional)
int? minStatusCode

Minimum response status (optional)
int? maxStatusCode

Maximum response status (optional)
System.Guid? inboxId

Inbox ID (optional)
System.Guid? smsId

Sms ID (optional)
System.Guid? attachmentId

Attachment ID (optional)
System.Guid? emailId

Email ID (optional)
System.Guid? phoneId

Phone ID (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageWebhookResult

PageWebhookResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAllWebhookResultsWithHttpInfo(int?, int?, string, string, DateTime?, DateTime?, bool?, string, string, int?, int?, Guid?, Guid?, Guid?, Guid?, Guid?, int)

Get results for all webhooks

Declaration
ApiResponse<PageWebhookResult> GetAllWebhookResultsWithHttpInfo(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? unseenOnly = null, string resultType = null, string eventName = null, int? minStatusCode = null, int? maxStatusCode = null, Guid? inboxId = null, Guid? smsId = null, Guid? attachmentId = null, Guid? emailId = null, Guid? phoneId = null, int operationIndex = 0)
Parameters
Type Name Description
int? page

Optional page index in list pagination (optional, default to 0)
int? size

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

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

Optional search filter (optional)
DateTime? since

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
bool? unseenOnly

Filter for unseen exceptions only (optional)
string resultType

Filter by result type (optional)
string eventName

Filter by event name (optional)
int? minStatusCode

Minimum response status (optional)
int? maxStatusCode

Maximum response status (optional)
System.Guid? inboxId

Inbox ID (optional)
System.Guid? smsId

Sms ID (optional)
System.Guid? attachmentId

Attachment ID (optional)
System.Guid? emailId

Email ID (optional)
System.Guid? phoneId

Phone ID (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PageWebhookResult>

ApiResponse of PageWebhookResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAllWebhooks(int?, int?, string, string, DateTime?, Guid?, Guid?, DateTime?, int)

List Webhooks Paginated

Declaration
PageWebhookProjection GetAllWebhooks(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, Guid? inboxId = null, Guid? phoneId = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
int? page

Optional page index in list pagination (optional, default to 0)
int? size

Optional page size for paginated result list. (optional, default to 20)
string sort

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

Optional search filter (optional)
DateTime? since

Filter by created at after the given timestamp (optional)
System.Guid? inboxId

Filter by inboxId (optional)
System.Guid? phoneId

Filter by phoneId (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageWebhookProjection

PageWebhookProjection
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAllWebhooksWithHttpInfo(int?, int?, string, string, DateTime?, Guid?, Guid?, DateTime?, int)

List Webhooks Paginated

Declaration
ApiResponse<PageWebhookProjection> GetAllWebhooksWithHttpInfo(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, Guid? inboxId = null, Guid? phoneId = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
int? page

Optional page index in list pagination (optional, default to 0)
int? size

Optional page size for paginated result list. (optional, default to 20)
string sort

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

Optional search filter (optional)
DateTime? since

Filter by created at after the given timestamp (optional)
System.Guid? inboxId

Filter by inboxId (optional)
System.Guid? phoneId

Filter by phoneId (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PageWebhookProjection>

ApiResponse of PageWebhookProjection
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetInboxWebhooksPaginated(Guid, int?, int?, string, string, DateTime?, DateTime?, int)

Get paginated webhooks for an Inbox

Declaration
PageWebhookProjection GetInboxWebhooksPaginated(Guid inboxId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
System.Guid inboxId
int? page

Optional page index in list pagination (optional, default to 0)
int? size

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

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

Optional search filter (optional)
DateTime? since

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageWebhookProjection

PageWebhookProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetInboxWebhooksPaginatedWithHttpInfo(Guid, int?, int?, string, string, DateTime?, DateTime?, int)

Get paginated webhooks for an Inbox

Declaration
ApiResponse<PageWebhookProjection> GetInboxWebhooksPaginatedWithHttpInfo(Guid inboxId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
System.Guid inboxId
int? page

Optional page index in list pagination (optional, default to 0)
int? size

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

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

Optional search filter (optional)
DateTime? since

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PageWebhookProjection>

ApiResponse of PageWebhookProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetJsonSchemaForWebhookEvent(string, int)

Declaration
JSONSchemaDto GetJsonSchemaForWebhookEvent(string _event, int operationIndex = 0)
Parameters
Type Name Description
string _event
int operationIndex

Index associated with the operation.
Returns
Type Description
JSONSchemaDto

JSONSchemaDto
Remarks

Get JSON Schema definition for webhook payload by event

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetJsonSchemaForWebhookEventWithHttpInfo(string, int)

Declaration
ApiResponse<JSONSchemaDto> GetJsonSchemaForWebhookEventWithHttpInfo(string _event, int operationIndex = 0)
Parameters
Type Name Description
string _event
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<JSONSchemaDto>

ApiResponse of JSONSchemaDto
Remarks

Get JSON Schema definition for webhook payload by event

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetJsonSchemaForWebhookPayload(Guid, int)

Declaration
JSONSchemaDto GetJsonSchemaForWebhookPayload(Guid webhookId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid webhookId
int operationIndex

Index associated with the operation.
Returns
Type Description
JSONSchemaDto

JSONSchemaDto
Remarks

Get JSON Schema definition for webhook payload

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetJsonSchemaForWebhookPayloadWithHttpInfo(Guid, int)

Declaration
ApiResponse<JSONSchemaDto> GetJsonSchemaForWebhookPayloadWithHttpInfo(Guid webhookId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid webhookId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<JSONSchemaDto>

ApiResponse of JSONSchemaDto
Remarks

Get JSON Schema definition for webhook payload

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetPhoneNumberWebhooksPaginated(Guid, int?, int?, string, DateTime?, DateTime?, int)

Get paginated webhooks for a phone number

Declaration
PageWebhookProjection GetPhoneNumberWebhooksPaginated(Guid phoneId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
System.Guid phoneId
int? page

Optional page index in list pagination (optional, default to 0)
int? size

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

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime? since

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageWebhookProjection

PageWebhookProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetPhoneNumberWebhooksPaginatedWithHttpInfo(Guid, int?, int?, string, DateTime?, DateTime?, int)

Get paginated webhooks for a phone number

Declaration
ApiResponse<PageWebhookProjection> GetPhoneNumberWebhooksPaginatedWithHttpInfo(Guid phoneId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
System.Guid phoneId
int? page

Optional page index in list pagination (optional, default to 0)
int? size

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

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime? since

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PageWebhookProjection>

ApiResponse of PageWebhookProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTestWebhookPayload(string, int)

Declaration
AbstractWebhookPayload GetTestWebhookPayload(string eventName = null, int operationIndex = 0)
Parameters
Type Name Description
string eventName

(optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
AbstractWebhookPayload

AbstractWebhookPayload
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTestWebhookPayloadBounce(int)

Declaration
WebhookBouncePayload GetTestWebhookPayloadBounce(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
WebhookBouncePayload

WebhookBouncePayload
Remarks

Get webhook test payload for bounce

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTestWebhookPayloadBounceRecipient(int)

Declaration
WebhookBounceRecipientPayload GetTestWebhookPayloadBounceRecipient(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
WebhookBounceRecipientPayload

WebhookBounceRecipientPayload
Remarks

Get webhook test payload for bounce recipient

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTestWebhookPayloadBounceRecipientWithHttpInfo(int)

Declaration
ApiResponse<WebhookBounceRecipientPayload> GetTestWebhookPayloadBounceRecipientWithHttpInfo(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<WebhookBounceRecipientPayload>

ApiResponse of WebhookBounceRecipientPayload
Remarks

Get webhook test payload for bounce recipient

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTestWebhookPayloadBounceWithHttpInfo(int)

Declaration
ApiResponse<WebhookBouncePayload> GetTestWebhookPayloadBounceWithHttpInfo(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<WebhookBouncePayload>

ApiResponse of WebhookBouncePayload
Remarks

Get webhook test payload for bounce

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTestWebhookPayloadDeliveryStatus(int)

Get webhook test payload for delivery status event

Declaration
WebhookDeliveryStatusPayload GetTestWebhookPayloadDeliveryStatus(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
WebhookDeliveryStatusPayload

WebhookDeliveryStatusPayload
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTestWebhookPayloadDeliveryStatusWithHttpInfo(int)

Get webhook test payload for delivery status event

Declaration
ApiResponse<WebhookDeliveryStatusPayload> GetTestWebhookPayloadDeliveryStatusWithHttpInfo(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<WebhookDeliveryStatusPayload>

ApiResponse of WebhookDeliveryStatusPayload
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTestWebhookPayloadEmailOpened(int)

Declaration
WebhookEmailOpenedPayload GetTestWebhookPayloadEmailOpened(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
WebhookEmailOpenedPayload

WebhookEmailOpenedPayload
Remarks

Get webhook test payload for email opened event

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTestWebhookPayloadEmailOpenedWithHttpInfo(int)

Declaration
ApiResponse<WebhookEmailOpenedPayload> GetTestWebhookPayloadEmailOpenedWithHttpInfo(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<WebhookEmailOpenedPayload>

ApiResponse of WebhookEmailOpenedPayload
Remarks

Get webhook test payload for email opened event

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTestWebhookPayloadEmailRead(int)

Declaration
WebhookEmailReadPayload GetTestWebhookPayloadEmailRead(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
WebhookEmailReadPayload

WebhookEmailReadPayload
Remarks

Get webhook test payload for email opened event

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTestWebhookPayloadEmailReadWithHttpInfo(int)

Declaration
ApiResponse<WebhookEmailReadPayload> GetTestWebhookPayloadEmailReadWithHttpInfo(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<WebhookEmailReadPayload>

ApiResponse of WebhookEmailReadPayload
Remarks

Get webhook test payload for email opened event

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTestWebhookPayloadForWebhook(Guid, int)

Declaration
AbstractWebhookPayload GetTestWebhookPayloadForWebhook(Guid webhookId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid webhookId
int operationIndex

Index associated with the operation.
Returns
Type Description
AbstractWebhookPayload

AbstractWebhookPayload
Remarks

Get example payload for webhook

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTestWebhookPayloadForWebhookWithHttpInfo(Guid, int)

Declaration
ApiResponse<AbstractWebhookPayload> GetTestWebhookPayloadForWebhookWithHttpInfo(Guid webhookId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid webhookId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<AbstractWebhookPayload>

ApiResponse of AbstractWebhookPayload
Remarks

Get example payload for webhook

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTestWebhookPayloadNewAttachment(int)

Get webhook test payload for new attachment event

Declaration
WebhookNewAttachmentPayload GetTestWebhookPayloadNewAttachment(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
WebhookNewAttachmentPayload

WebhookNewAttachmentPayload
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTestWebhookPayloadNewAttachmentWithHttpInfo(int)

Get webhook test payload for new attachment event

Declaration
ApiResponse<WebhookNewAttachmentPayload> GetTestWebhookPayloadNewAttachmentWithHttpInfo(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<WebhookNewAttachmentPayload>

ApiResponse of WebhookNewAttachmentPayload
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTestWebhookPayloadNewContact(int)

Get webhook test payload for new contact event

Declaration
WebhookNewContactPayload GetTestWebhookPayloadNewContact(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
WebhookNewContactPayload

WebhookNewContactPayload
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTestWebhookPayloadNewContactWithHttpInfo(int)

Get webhook test payload for new contact event

Declaration
ApiResponse<WebhookNewContactPayload> GetTestWebhookPayloadNewContactWithHttpInfo(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<WebhookNewContactPayload>

ApiResponse of WebhookNewContactPayload
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTestWebhookPayloadNewEmail(int)

Get webhook test payload for new email event

Declaration
WebhookNewEmailPayload GetTestWebhookPayloadNewEmail(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
WebhookNewEmailPayload

WebhookNewEmailPayload
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTestWebhookPayloadNewEmailWithHttpInfo(int)

Get webhook test payload for new email event

Declaration
ApiResponse<WebhookNewEmailPayload> GetTestWebhookPayloadNewEmailWithHttpInfo(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<WebhookNewEmailPayload>

ApiResponse of WebhookNewEmailPayload
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTestWebhookPayloadNewSms(int)

Get webhook test payload for new sms event

Declaration
WebhookNewSmsPayload GetTestWebhookPayloadNewSms(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
WebhookNewSmsPayload

WebhookNewSmsPayload
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTestWebhookPayloadNewSmsWithHttpInfo(int)

Get webhook test payload for new sms event

Declaration
ApiResponse<WebhookNewSmsPayload> GetTestWebhookPayloadNewSmsWithHttpInfo(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<WebhookNewSmsPayload>

ApiResponse of WebhookNewSmsPayload
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTestWebhookPayloadWithHttpInfo(string, int)

Declaration
ApiResponse<AbstractWebhookPayload> GetTestWebhookPayloadWithHttpInfo(string eventName = null, int operationIndex = 0)
Parameters
Type Name Description
string eventName

(optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<AbstractWebhookPayload>

ApiResponse of AbstractWebhookPayload
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetWebhook(Guid, int)

Get a webhook

Declaration
WebhookDto GetWebhook(Guid webhookId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid webhookId
int operationIndex

Index associated with the operation.
Returns
Type Description
WebhookDto

WebhookDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetWebhookResult(Guid, int)

Get a webhook result for a webhook

Declaration
WebhookResultDto GetWebhookResult(Guid webhookResultId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid webhookResultId

Webhook Result ID
int operationIndex

Index associated with the operation.
Returns
Type Description
WebhookResultDto

WebhookResultDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetWebhookResults(Guid, int?, int?, string, string, DateTime?, DateTime?, bool?, string, string, int?, int?, Guid?, Guid?, Guid?, Guid?, Guid?, int)

Get a webhook results for a webhook

Declaration
PageWebhookResult GetWebhookResults(Guid webhookId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? unseenOnly = null, string resultType = null, string eventName = null, int? minStatusCode = null, int? maxStatusCode = null, Guid? inboxId = null, Guid? smsId = null, Guid? attachmentId = null, Guid? emailId = null, Guid? phoneId = null, int operationIndex = 0)
Parameters
Type Name Description
System.Guid webhookId

ID of webhook to get results for
int? page

Optional page index in list pagination (optional, default to 0)
int? size

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

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

Optional search filter (optional)
DateTime? since

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
bool? unseenOnly

Filter for unseen exceptions only (optional)
string resultType

Filter by result type (optional)
string eventName

Filter by event name (optional)
int? minStatusCode

Minimum response status (optional)
int? maxStatusCode

Maximum response status (optional)
System.Guid? inboxId

Inbox ID (optional)
System.Guid? smsId

Sms ID (optional)
System.Guid? attachmentId

Attachment ID (optional)
System.Guid? emailId

Email ID (optional)
System.Guid? phoneId

Phone ID (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageWebhookResult

PageWebhookResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetWebhookResultsCount(Guid, int)

Get a webhook results count for a webhook

Declaration
CountDto GetWebhookResultsCount(Guid webhookId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid webhookId

ID of webhook to get results for
int operationIndex

Index associated with the operation.
Returns
Type Description
CountDto

CountDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetWebhookResultsCountWithHttpInfo(Guid, int)

Get a webhook results count for a webhook

Declaration
ApiResponse<CountDto> GetWebhookResultsCountWithHttpInfo(Guid webhookId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid webhookId

ID of webhook to get results for
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<CountDto>

ApiResponse of CountDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetWebhookResultsUnseenErrorCount(int)

Get count of unseen webhook results with error status

Declaration
UnseenErrorCountDto GetWebhookResultsUnseenErrorCount(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
UnseenErrorCountDto

UnseenErrorCountDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetWebhookResultsUnseenErrorCountWithHttpInfo(int)

Get count of unseen webhook results with error status

Declaration
ApiResponse<UnseenErrorCountDto> GetWebhookResultsUnseenErrorCountWithHttpInfo(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<UnseenErrorCountDto>

ApiResponse of UnseenErrorCountDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetWebhookResultsWithHttpInfo(Guid, int?, int?, string, string, DateTime?, DateTime?, bool?, string, string, int?, int?, Guid?, Guid?, Guid?, Guid?, Guid?, int)

Get a webhook results for a webhook

Declaration
ApiResponse<PageWebhookResult> GetWebhookResultsWithHttpInfo(Guid webhookId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? unseenOnly = null, string resultType = null, string eventName = null, int? minStatusCode = null, int? maxStatusCode = null, Guid? inboxId = null, Guid? smsId = null, Guid? attachmentId = null, Guid? emailId = null, Guid? phoneId = null, int operationIndex = 0)
Parameters
Type Name Description
System.Guid webhookId

ID of webhook to get results for
int? page

Optional page index in list pagination (optional, default to 0)
int? size

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

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

Optional search filter (optional)
DateTime? since

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
bool? unseenOnly

Filter for unseen exceptions only (optional)
string resultType

Filter by result type (optional)
string eventName

Filter by event name (optional)
int? minStatusCode

Minimum response status (optional)
int? maxStatusCode

Maximum response status (optional)
System.Guid? inboxId

Inbox ID (optional)
System.Guid? smsId

Sms ID (optional)
System.Guid? attachmentId

Attachment ID (optional)
System.Guid? emailId

Email ID (optional)
System.Guid? phoneId

Phone ID (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PageWebhookResult>

ApiResponse of PageWebhookResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetWebhookResultWithHttpInfo(Guid, int)

Get a webhook result for a webhook

Declaration
ApiResponse<WebhookResultDto> GetWebhookResultWithHttpInfo(Guid webhookResultId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid webhookResultId

Webhook Result ID
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<WebhookResultDto>

ApiResponse of WebhookResultDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetWebhooks(Guid, int)

Get all webhooks for an Inbox

Declaration
[Obsolete]
List<WebhookDto> GetWebhooks(Guid inboxId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid inboxId
int operationIndex

Index associated with the operation.
Returns
Type Description
System.Collections.Generic.List<T><WebhookDto>

List<WebhookDto>
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetWebhooksWithHttpInfo(Guid, int)

Get all webhooks for an Inbox

Declaration
[Obsolete]
ApiResponse<List<WebhookDto>> GetWebhooksWithHttpInfo(Guid inboxId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid inboxId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<System.Collections.Generic.List<T><WebhookDto>>

ApiResponse of List<WebhookDto>
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetWebhookWithHttpInfo(Guid, int)

Get a webhook

Declaration
ApiResponse<WebhookDto> GetWebhookWithHttpInfo(Guid webhookId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid webhookId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<WebhookDto>

ApiResponse of WebhookDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

RedriveAllWebhookResults(int)

Redrive all webhook results that have failed status

Declaration
WebhookRedriveAllResult RedriveAllWebhookResults(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
WebhookRedriveAllResult

WebhookRedriveAllResult
Remarks

Allows you to resend webhook payloads for any recorded webhook result that failed to deliver the payload.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

RedriveAllWebhookResultsWithHttpInfo(int)

Redrive all webhook results that have failed status

Declaration
ApiResponse<WebhookRedriveAllResult> RedriveAllWebhookResultsWithHttpInfo(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<WebhookRedriveAllResult>

ApiResponse of WebhookRedriveAllResult
Remarks

Allows you to resend webhook payloads for any recorded webhook result that failed to deliver the payload.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

RedriveWebhookResult(Guid, int)

Get a webhook result and try to resend the original webhook payload

Declaration
WebhookRedriveResult RedriveWebhookResult(Guid webhookResultId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid webhookResultId

Webhook Result ID
int operationIndex

Index associated with the operation.
Returns
Type Description
WebhookRedriveResult

WebhookRedriveResult
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

RedriveWebhookResultWithHttpInfo(Guid, int)

Get a webhook result and try to resend the original webhook payload

Declaration
ApiResponse<WebhookRedriveResult> RedriveWebhookResultWithHttpInfo(Guid webhookResultId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid webhookResultId

Webhook Result ID
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<WebhookRedriveResult>

ApiResponse of WebhookRedriveResult
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SendTestData(Guid, int)

Send webhook test data

Declaration
WebhookTestResult SendTestData(Guid webhookId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid webhookId
int operationIndex

Index associated with the operation.
Returns
Type Description
WebhookTestResult

WebhookTestResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SendTestDataWithHttpInfo(Guid, int)

Send webhook test data

Declaration
ApiResponse<WebhookTestResult> SendTestDataWithHttpInfo(Guid webhookId, int operationIndex = 0)
Parameters
Type Name Description
System.Guid webhookId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<WebhookTestResult>

ApiResponse of WebhookTestResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

UpdateWebhookHeaders(Guid, WebhookHeaders, int)

Update a webhook request headers

Declaration
WebhookDto UpdateWebhookHeaders(Guid webhookId, WebhookHeaders webhookHeaders, int operationIndex = 0)
Parameters
Type Name Description
System.Guid webhookId
WebhookHeaders webhookHeaders
int operationIndex

Index associated with the operation.
Returns
Type Description
WebhookDto

WebhookDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

UpdateWebhookHeadersWithHttpInfo(Guid, WebhookHeaders, int)

Update a webhook request headers

Declaration
ApiResponse<WebhookDto> UpdateWebhookHeadersWithHttpInfo(Guid webhookId, WebhookHeaders webhookHeaders, int operationIndex = 0)
Parameters
Type Name Description
System.Guid webhookId
WebhookHeaders webhookHeaders
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<WebhookDto>

ApiResponse of WebhookDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

VerifyWebhookSignature(VerifyWebhookSignatureOptions, int)

Verify a webhook payload signature

Declaration
VerifyWebhookSignatureResults VerifyWebhookSignature(VerifyWebhookSignatureOptions verifyWebhookSignatureOptions, int operationIndex = 0)
Parameters
Type Name Description
VerifyWebhookSignatureOptions verifyWebhookSignatureOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
VerifyWebhookSignatureResults

VerifyWebhookSignatureResults
Remarks

Verify a webhook payload using the messageId and signature. This allows you to be sure that MailSlurp sent the payload and not another server.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

VerifyWebhookSignatureWithHttpInfo(VerifyWebhookSignatureOptions, int)

Verify a webhook payload signature

Declaration
ApiResponse<VerifyWebhookSignatureResults> VerifyWebhookSignatureWithHttpInfo(VerifyWebhookSignatureOptions verifyWebhookSignatureOptions, int operationIndex = 0)
Parameters
Type Name Description
VerifyWebhookSignatureOptions verifyWebhookSignatureOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<VerifyWebhookSignatureResults>

ApiResponse of VerifyWebhookSignatureResults
Remarks

Verify a webhook payload using the messageId and signature. This allows you to be sure that MailSlurp sent the payload and not another server.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

WaitForWebhookResults(Guid, int, int, int)

Wait for webhook results for a webhook

Declaration
List<WebhookResultDto> WaitForWebhookResults(Guid webhookId, int expectedCount, int timeout, int operationIndex = 0)
Parameters
Type Name Description
System.Guid webhookId

ID of webhook to get results for
int expectedCount

Expected result count
int timeout

Max time to wait in milliseconds
int operationIndex

Index associated with the operation.
Returns
Type Description
System.Collections.Generic.List<T><WebhookResultDto>

List<WebhookResultDto>
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

WaitForWebhookResultsWithHttpInfo(Guid, int, int, int)

Wait for webhook results for a webhook

Declaration
ApiResponse<List<WebhookResultDto>> WaitForWebhookResultsWithHttpInfo(Guid webhookId, int expectedCount, int timeout, int operationIndex = 0)
Parameters
Type Name Description
System.Guid webhookId

ID of webhook to get results for
int expectedCount

Expected result count
int timeout

Max time to wait in milliseconds
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<System.Collections.Generic.List<T><WebhookResultDto>>

ApiResponse of List<WebhookResultDto>
Exceptions
Type Condition
ApiException

Thrown when fails to make API call