Interface IWebhookControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IWebhookControllerApiAsync : IApiAccessor

Methods

View Source

CreateAccountWebhookAsync(CreateWebhookOptions, int, CancellationToken)

Attach a WebHook URL to an inbox

Declaration

Task<WebhookDto> CreateAccountWebhookAsync(CreateWebhookOptions createWebhookOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateWebhookOptions	createWebhookOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<WebhookDto>	Task 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

CreateAccountWebhookWithHttpInfoAsync(CreateWebhookOptions, int, CancellationToken)

Attach a WebHook URL to an inbox

Declaration

Task<ApiResponse<WebhookDto>> CreateAccountWebhookWithHttpInfoAsync(CreateWebhookOptions createWebhookOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateWebhookOptions	createWebhookOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<WebhookDto>>	Task of ApiResponse (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

CreateWebhookAsync(Guid, CreateWebhookOptions, int, CancellationToken)

Attach a WebHook URL to an inbox

Declaration

Task<WebhookDto> CreateWebhookAsync(Guid inboxId, CreateWebhookOptions createWebhookOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
CreateWebhookOptions	createWebhookOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<WebhookDto>	Task 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

CreateWebhookForPhoneNumberAsync(Guid, CreateWebhookOptions, int, CancellationToken)

Attach a WebHook URL to a phone number

Declaration

Task<WebhookDto> CreateWebhookForPhoneNumberAsync(Guid phoneNumberId, CreateWebhookOptions createWebhookOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	phoneNumberId
CreateWebhookOptions	createWebhookOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<WebhookDto>	Task 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

CreateWebhookForPhoneNumberWithHttpInfoAsync(Guid, CreateWebhookOptions, int, CancellationToken)

Attach a WebHook URL to a phone number

Declaration

Task<ApiResponse<WebhookDto>> CreateWebhookForPhoneNumberWithHttpInfoAsync(Guid phoneNumberId, CreateWebhookOptions createWebhookOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	phoneNumberId
CreateWebhookOptions	createWebhookOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<WebhookDto>>	Task of ApiResponse (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

CreateWebhookWithHttpInfoAsync(Guid, CreateWebhookOptions, int, CancellationToken)

Attach a WebHook URL to an inbox

Declaration

Task<ApiResponse<WebhookDto>> CreateWebhookWithHttpInfoAsync(Guid inboxId, CreateWebhookOptions createWebhookOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
CreateWebhookOptions	createWebhookOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<WebhookDto>>	Task of ApiResponse (WebhookDto)

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteAllWebhooksAsync(DateTime?, int, CancellationToken)

Delete all webhooks

Declaration

Task DeleteAllWebhooksAsync(DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
DateTime?	before	before (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteAllWebhooksWithHttpInfoAsync(DateTime?, int, CancellationToken)

Delete all webhooks

Declaration

Task<ApiResponse<object>> DeleteAllWebhooksWithHttpInfoAsync(DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
DateTime?	before	before (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteWebhookAsync(Guid, Guid, int, CancellationToken)

Delete and disable a Webhook for an Inbox

Declaration

Task DeleteWebhookAsync(Guid inboxId, Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
System.Guid	webhookId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteWebhookByIdAsync(Guid, int, CancellationToken)

Delete a webhook

Declaration

Task DeleteWebhookByIdAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	webhookId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteWebhookByIdWithHttpInfoAsync(Guid, int, CancellationToken)

Delete a webhook

Declaration

Task<ApiResponse<object>> DeleteWebhookByIdWithHttpInfoAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	webhookId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteWebhookWithHttpInfoAsync(Guid, Guid, int, CancellationToken)

Delete and disable a Webhook for an Inbox

Declaration

Task<ApiResponse<object>> DeleteWebhookWithHttpInfoAsync(Guid inboxId, Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
System.Guid	webhookId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllAccountWebhooksAsync(int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

List account webhooks Paginated

Declaration

Task<PageWebhookProjection> GetAllAccountWebhooksAsync(int? page = null, int? size = null, string sort = null, string eventType = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageWebhookProjection>	Task 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

GetAllAccountWebhooksWithHttpInfoAsync(int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

List account webhooks Paginated

Declaration

Task<ApiResponse<PageWebhookProjection>> GetAllAccountWebhooksWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, string eventType = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageWebhookProjection>>	Task of ApiResponse (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

GetAllWebhookResultsAsync(int?, int?, string, string, DateTime?, DateTime?, bool?, string, string, int?, int?, Guid?, Guid?, Guid?, Guid?, Guid?, int, CancellationToken)

Get results for all webhooks

Declaration

Task<PageWebhookResult> GetAllWebhookResultsAsync(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, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageWebhookResult>	Task of PageWebhookResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllWebhookResultsWithHttpInfoAsync(int?, int?, string, string, DateTime?, DateTime?, bool?, string, string, int?, int?, Guid?, Guid?, Guid?, Guid?, Guid?, int, CancellationToken)

Get results for all webhooks

Declaration

Task<ApiResponse<PageWebhookResult>> GetAllWebhookResultsWithHttpInfoAsync(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, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageWebhookResult>>	Task of ApiResponse (PageWebhookResult)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAllWebhooksAsync(int?, int?, string, string, DateTime?, Guid?, Guid?, DateTime?, int, CancellationToken)

List Webhooks Paginated

Declaration

Task<PageWebhookProjection> GetAllWebhooksAsync(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, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageWebhookProjection>	Task 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

GetAllWebhooksWithHttpInfoAsync(int?, int?, string, string, DateTime?, Guid?, Guid?, DateTime?, int, CancellationToken)

List Webhooks Paginated

Declaration

Task<ApiResponse<PageWebhookProjection>> GetAllWebhooksWithHttpInfoAsync(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, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageWebhookProjection>>	Task of ApiResponse (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

GetInboxWebhooksPaginatedAsync(Guid, int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

Get paginated webhooks for an Inbox

Declaration

Task<PageWebhookProjection> GetInboxWebhooksPaginatedAsync(Guid inboxId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageWebhookProjection>	Task of PageWebhookProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxWebhooksPaginatedWithHttpInfoAsync(Guid, int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

Get paginated webhooks for an Inbox

Declaration

Task<ApiResponse<PageWebhookProjection>> GetInboxWebhooksPaginatedWithHttpInfoAsync(Guid inboxId, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageWebhookProjection>>	Task of ApiResponse (PageWebhookProjection)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetJsonSchemaForWebhookEventAsync(string, int, CancellationToken)

Declaration

Task<JSONSchemaDto> GetJsonSchemaForWebhookEventAsync(string _event, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	_event
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<JSONSchemaDto>	Task 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

GetJsonSchemaForWebhookEventWithHttpInfoAsync(string, int, CancellationToken)

Declaration

Task<ApiResponse<JSONSchemaDto>> GetJsonSchemaForWebhookEventWithHttpInfoAsync(string _event, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	_event
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<JSONSchemaDto>>	Task of ApiResponse (JSONSchemaDto)

Remarks

Get JSON Schema definition for webhook payload by event

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetJsonSchemaForWebhookPayloadAsync(Guid, int, CancellationToken)

Declaration

Task<JSONSchemaDto> GetJsonSchemaForWebhookPayloadAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	webhookId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<JSONSchemaDto>	Task of JSONSchemaDto

Remarks

Get JSON Schema definition for webhook payload

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetJsonSchemaForWebhookPayloadWithHttpInfoAsync(Guid, int, CancellationToken)

Declaration

Task<ApiResponse<JSONSchemaDto>> GetJsonSchemaForWebhookPayloadWithHttpInfoAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	webhookId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<JSONSchemaDto>>	Task of ApiResponse (JSONSchemaDto)

Remarks

Get JSON Schema definition for webhook payload

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetPhoneNumberWebhooksPaginatedAsync(Guid, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get paginated webhooks for a phone number

Declaration

Task<PageWebhookProjection> GetPhoneNumberWebhooksPaginatedAsync(Guid phoneId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageWebhookProjection>	Task of PageWebhookProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetPhoneNumberWebhooksPaginatedWithHttpInfoAsync(Guid, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Get paginated webhooks for a phone number

Declaration

Task<ApiResponse<PageWebhookProjection>> GetPhoneNumberWebhooksPaginatedWithHttpInfoAsync(Guid phoneId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageWebhookProjection>>	Task of ApiResponse (PageWebhookProjection)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTestWebhookPayloadAsync(string, int, CancellationToken)

Declaration

Task<AbstractWebhookPayload> GetTestWebhookPayloadAsync(string eventName = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	eventName	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<AbstractWebhookPayload>	Task 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

GetTestWebhookPayloadBounceAsync(int, CancellationToken)

Declaration

Task<WebhookBouncePayload> GetTestWebhookPayloadBounceAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<WebhookBouncePayload>	Task of WebhookBouncePayload

Remarks

Get webhook test payload for bounce

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTestWebhookPayloadBounceRecipientAsync(int, CancellationToken)

Declaration

Task<WebhookBounceRecipientPayload> GetTestWebhookPayloadBounceRecipientAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<WebhookBounceRecipientPayload>	Task of WebhookBounceRecipientPayload

Remarks

Get webhook test payload for bounce recipient

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTestWebhookPayloadBounceRecipientWithHttpInfoAsync(int, CancellationToken)

Declaration

Task<ApiResponse<WebhookBounceRecipientPayload>> GetTestWebhookPayloadBounceRecipientWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<WebhookBounceRecipientPayload>>	Task of ApiResponse (WebhookBounceRecipientPayload)

Remarks

Get webhook test payload for bounce recipient

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTestWebhookPayloadBounceWithHttpInfoAsync(int, CancellationToken)

Declaration

Task<ApiResponse<WebhookBouncePayload>> GetTestWebhookPayloadBounceWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<WebhookBouncePayload>>	Task of ApiResponse (WebhookBouncePayload)

Remarks

Get webhook test payload for bounce

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTestWebhookPayloadDeliveryStatusAsync(int, CancellationToken)

Get webhook test payload for delivery status event

Declaration

Task<WebhookDeliveryStatusPayload> GetTestWebhookPayloadDeliveryStatusAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<WebhookDeliveryStatusPayload>	Task of WebhookDeliveryStatusPayload

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTestWebhookPayloadDeliveryStatusWithHttpInfoAsync(int, CancellationToken)

Get webhook test payload for delivery status event

Declaration

Task<ApiResponse<WebhookDeliveryStatusPayload>> GetTestWebhookPayloadDeliveryStatusWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<WebhookDeliveryStatusPayload>>	Task of ApiResponse (WebhookDeliveryStatusPayload)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTestWebhookPayloadEmailOpenedAsync(int, CancellationToken)

Declaration

Task<WebhookEmailOpenedPayload> GetTestWebhookPayloadEmailOpenedAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<WebhookEmailOpenedPayload>	Task of WebhookEmailOpenedPayload

Remarks

Get webhook test payload for email opened event

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTestWebhookPayloadEmailOpenedWithHttpInfoAsync(int, CancellationToken)

Declaration

Task<ApiResponse<WebhookEmailOpenedPayload>> GetTestWebhookPayloadEmailOpenedWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<WebhookEmailOpenedPayload>>	Task of ApiResponse (WebhookEmailOpenedPayload)

Remarks

Get webhook test payload for email opened event

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTestWebhookPayloadEmailReadAsync(int, CancellationToken)

Declaration

Task<WebhookEmailReadPayload> GetTestWebhookPayloadEmailReadAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<WebhookEmailReadPayload>	Task of WebhookEmailReadPayload

Remarks

Get webhook test payload for email opened event

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTestWebhookPayloadEmailReadWithHttpInfoAsync(int, CancellationToken)

Declaration

Task<ApiResponse<WebhookEmailReadPayload>> GetTestWebhookPayloadEmailReadWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<WebhookEmailReadPayload>>	Task of ApiResponse (WebhookEmailReadPayload)

Remarks

Get webhook test payload for email opened event

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTestWebhookPayloadForWebhookAsync(Guid, int, CancellationToken)

Declaration

Task<AbstractWebhookPayload> GetTestWebhookPayloadForWebhookAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	webhookId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<AbstractWebhookPayload>	Task of AbstractWebhookPayload

Remarks

Get example payload for webhook

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTestWebhookPayloadForWebhookWithHttpInfoAsync(Guid, int, CancellationToken)

Declaration

Task<ApiResponse<AbstractWebhookPayload>> GetTestWebhookPayloadForWebhookWithHttpInfoAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	webhookId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<AbstractWebhookPayload>>	Task of ApiResponse (AbstractWebhookPayload)

Remarks

Get example payload for webhook

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTestWebhookPayloadNewAttachmentAsync(int, CancellationToken)

Get webhook test payload for new attachment event

Declaration

Task<WebhookNewAttachmentPayload> GetTestWebhookPayloadNewAttachmentAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<WebhookNewAttachmentPayload>	Task of WebhookNewAttachmentPayload

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTestWebhookPayloadNewAttachmentWithHttpInfoAsync(int, CancellationToken)

Get webhook test payload for new attachment event

Declaration

Task<ApiResponse<WebhookNewAttachmentPayload>> GetTestWebhookPayloadNewAttachmentWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<WebhookNewAttachmentPayload>>	Task of ApiResponse (WebhookNewAttachmentPayload)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTestWebhookPayloadNewContactAsync(int, CancellationToken)

Get webhook test payload for new contact event

Declaration

Task<WebhookNewContactPayload> GetTestWebhookPayloadNewContactAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<WebhookNewContactPayload>	Task of WebhookNewContactPayload

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTestWebhookPayloadNewContactWithHttpInfoAsync(int, CancellationToken)

Get webhook test payload for new contact event

Declaration

Task<ApiResponse<WebhookNewContactPayload>> GetTestWebhookPayloadNewContactWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<WebhookNewContactPayload>>	Task of ApiResponse (WebhookNewContactPayload)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTestWebhookPayloadNewEmailAsync(int, CancellationToken)

Get webhook test payload for new email event

Declaration

Task<WebhookNewEmailPayload> GetTestWebhookPayloadNewEmailAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<WebhookNewEmailPayload>	Task of WebhookNewEmailPayload

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTestWebhookPayloadNewEmailWithHttpInfoAsync(int, CancellationToken)

Get webhook test payload for new email event

Declaration

Task<ApiResponse<WebhookNewEmailPayload>> GetTestWebhookPayloadNewEmailWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<WebhookNewEmailPayload>>	Task of ApiResponse (WebhookNewEmailPayload)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTestWebhookPayloadNewSmsAsync(int, CancellationToken)

Get webhook test payload for new sms event

Declaration

Task<WebhookNewSmsPayload> GetTestWebhookPayloadNewSmsAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<WebhookNewSmsPayload>	Task of WebhookNewSmsPayload

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTestWebhookPayloadNewSmsWithHttpInfoAsync(int, CancellationToken)

Get webhook test payload for new sms event

Declaration

Task<ApiResponse<WebhookNewSmsPayload>> GetTestWebhookPayloadNewSmsWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<WebhookNewSmsPayload>>	Task of ApiResponse (WebhookNewSmsPayload)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetTestWebhookPayloadWithHttpInfoAsync(string, int, CancellationToken)

Declaration

Task<ApiResponse<AbstractWebhookPayload>> GetTestWebhookPayloadWithHttpInfoAsync(string eventName = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	eventName	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<AbstractWebhookPayload>>	Task of ApiResponse (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

GetWebhookAsync(Guid, int, CancellationToken)

Get a webhook

Declaration

Task<WebhookDto> GetWebhookAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	webhookId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<WebhookDto>	Task of WebhookDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetWebhookResultAsync(Guid, int, CancellationToken)

Get a webhook result for a webhook

Declaration

Task<WebhookResultDto> GetWebhookResultAsync(Guid webhookResultId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	webhookResultId	Webhook Result ID
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<WebhookResultDto>	Task of WebhookResultDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetWebhookResultsAsync(Guid, int?, int?, string, string, DateTime?, DateTime?, bool?, string, string, int?, int?, Guid?, Guid?, Guid?, Guid?, Guid?, int, CancellationToken)

Get a webhook results for a webhook

Declaration

Task<PageWebhookResult> GetWebhookResultsAsync(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, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageWebhookResult>	Task of PageWebhookResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetWebhookResultsCountAsync(Guid, int, CancellationToken)

Get a webhook results count for a webhook

Declaration

Task<CountDto> GetWebhookResultsCountAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	webhookId	ID of webhook to get results for
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<CountDto>	Task of CountDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetWebhookResultsCountWithHttpInfoAsync(Guid, int, CancellationToken)

Get a webhook results count for a webhook

Declaration

Task<ApiResponse<CountDto>> GetWebhookResultsCountWithHttpInfoAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	webhookId	ID of webhook to get results for
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<CountDto>>	Task of ApiResponse (CountDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetWebhookResultsUnseenErrorCountAsync(int, CancellationToken)

Get count of unseen webhook results with error status

Declaration

Task<UnseenErrorCountDto> GetWebhookResultsUnseenErrorCountAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<UnseenErrorCountDto>	Task of UnseenErrorCountDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetWebhookResultsUnseenErrorCountWithHttpInfoAsync(int, CancellationToken)

Get count of unseen webhook results with error status

Declaration

Task<ApiResponse<UnseenErrorCountDto>> GetWebhookResultsUnseenErrorCountWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<UnseenErrorCountDto>>	Task of ApiResponse (UnseenErrorCountDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetWebhookResultsWithHttpInfoAsync(Guid, int?, int?, string, string, DateTime?, DateTime?, bool?, string, string, int?, int?, Guid?, Guid?, Guid?, Guid?, Guid?, int, CancellationToken)

Get a webhook results for a webhook

Declaration

Task<ApiResponse<PageWebhookResult>> GetWebhookResultsWithHttpInfoAsync(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, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageWebhookResult>>	Task of ApiResponse (PageWebhookResult)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetWebhookResultWithHttpInfoAsync(Guid, int, CancellationToken)

Get a webhook result for a webhook

Declaration

Task<ApiResponse<WebhookResultDto>> GetWebhookResultWithHttpInfoAsync(Guid webhookResultId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	webhookResultId	Webhook Result ID
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<WebhookResultDto>>	Task of ApiResponse (WebhookResultDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetWebhooksAsync(Guid, int, CancellationToken)

Get all webhooks for an Inbox

Declaration

[Obsolete]
Task<List<WebhookDto>> GetWebhooksAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<System.Collections.Generic.List<T><WebhookDto>>	Task of List<WebhookDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetWebhooksWithHttpInfoAsync(Guid, int, CancellationToken)

Get all webhooks for an Inbox

Declaration

[Obsolete]
Task<ApiResponse<List<WebhookDto>>> GetWebhooksWithHttpInfoAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	inboxId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<System.Collections.Generic.List<T><WebhookDto>>>	Task of ApiResponse (List<WebhookDto>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetWebhookWithHttpInfoAsync(Guid, int, CancellationToken)

Get a webhook

Declaration

Task<ApiResponse<WebhookDto>> GetWebhookWithHttpInfoAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	webhookId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<WebhookDto>>	Task of ApiResponse (WebhookDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

RedriveAllWebhookResultsAsync(int, CancellationToken)

Redrive all webhook results that have failed status

Declaration

Task<WebhookRedriveAllResult> RedriveAllWebhookResultsAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<WebhookRedriveAllResult>	Task 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

RedriveAllWebhookResultsWithHttpInfoAsync(int, CancellationToken)

Redrive all webhook results that have failed status

Declaration

Task<ApiResponse<WebhookRedriveAllResult>> RedriveAllWebhookResultsWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<WebhookRedriveAllResult>>	Task of ApiResponse (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

RedriveWebhookResultAsync(Guid, int, CancellationToken)

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

Declaration

Task<WebhookRedriveResult> RedriveWebhookResultAsync(Guid webhookResultId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	webhookResultId	Webhook Result ID
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<WebhookRedriveResult>	Task 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

RedriveWebhookResultWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

Task<ApiResponse<WebhookRedriveResult>> RedriveWebhookResultWithHttpInfoAsync(Guid webhookResultId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	webhookResultId	Webhook Result ID
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<WebhookRedriveResult>>	Task of ApiResponse (WebhookRedriveResult)

Remarks

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendTestDataAsync(Guid, int, CancellationToken)

Send webhook test data

Declaration

Task<WebhookTestResult> SendTestDataAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	webhookId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<WebhookTestResult>	Task of WebhookTestResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendTestDataWithHttpInfoAsync(Guid, int, CancellationToken)

Send webhook test data

Declaration

Task<ApiResponse<WebhookTestResult>> SendTestDataWithHttpInfoAsync(Guid webhookId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	webhookId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<WebhookTestResult>>	Task of ApiResponse (WebhookTestResult)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateWebhookHeadersAsync(Guid, WebhookHeaders, int, CancellationToken)

Update a webhook request headers

Declaration

Task<WebhookDto> UpdateWebhookHeadersAsync(Guid webhookId, WebhookHeaders webhookHeaders, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	webhookId
WebhookHeaders	webhookHeaders
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<WebhookDto>	Task of WebhookDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateWebhookHeadersWithHttpInfoAsync(Guid, WebhookHeaders, int, CancellationToken)

Update a webhook request headers

Declaration

Task<ApiResponse<WebhookDto>> UpdateWebhookHeadersWithHttpInfoAsync(Guid webhookId, WebhookHeaders webhookHeaders, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	webhookId
WebhookHeaders	webhookHeaders
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<WebhookDto>>	Task of ApiResponse (WebhookDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

VerifyWebhookSignatureAsync(VerifyWebhookSignatureOptions, int, CancellationToken)

Verify a webhook payload signature

Declaration

Task<VerifyWebhookSignatureResults> VerifyWebhookSignatureAsync(VerifyWebhookSignatureOptions verifyWebhookSignatureOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
VerifyWebhookSignatureOptions	verifyWebhookSignatureOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<VerifyWebhookSignatureResults>	Task 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

VerifyWebhookSignatureWithHttpInfoAsync(VerifyWebhookSignatureOptions, int, CancellationToken)

Verify a webhook payload signature

Declaration

Task<ApiResponse<VerifyWebhookSignatureResults>> VerifyWebhookSignatureWithHttpInfoAsync(VerifyWebhookSignatureOptions verifyWebhookSignatureOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
VerifyWebhookSignatureOptions	verifyWebhookSignatureOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<VerifyWebhookSignatureResults>>	Task of ApiResponse (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

WaitForWebhookResultsAsync(Guid, int, int, int, CancellationToken)

Wait for webhook results for a webhook

Declaration

Task<List<WebhookResultDto>> WaitForWebhookResultsAsync(Guid webhookId, int expectedCount, int timeout, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<System.Collections.Generic.List<T><WebhookResultDto>>	Task of List<WebhookResultDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

WaitForWebhookResultsWithHttpInfoAsync(Guid, int, int, int, CancellationToken)

Wait for webhook results for a webhook

Declaration

Task<ApiResponse<List<WebhookResultDto>>> WaitForWebhookResultsWithHttpInfoAsync(Guid webhookId, int expectedCount, int timeout, int operationIndex = 0, CancellationToken cancellationToken = default)

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.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<System.Collections.Generic.List<T><WebhookResultDto>>>	Task of ApiResponse (List<WebhookResultDto>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call