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 : IApiAccessorMethods
View SourceCreateAccountWebhook(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 |
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 |
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 |
|---|---|---|
| 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 |
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 |
|---|---|---|
| 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 |
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 |
|---|---|---|
| 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 |
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 |
|---|---|---|
| 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 |
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 |
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 |
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 |
|---|---|---|
| Guid | inboxId | |
| Guid | webhookId | |
| int | operationIndex | Index associated with the operation. |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DeleteWebhookById(Guid, int)
Delete a webhook
Declaration
void DeleteWebhookById(Guid webhookId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | webhookId | |
| int | operationIndex | Index associated with the operation. |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DeleteWebhookByIdWithHttpInfo(Guid, int)
Delete a webhook
Declaration
ApiResponse<object> DeleteWebhookByIdWithHttpInfo(Guid webhookId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| 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 |
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 |
|---|---|---|
| Guid | inboxId | |
| 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 |
GetAllAccountWebhooks(int?, int?, string, DateTime?, DateTime?, string, string, string, int)
List account webhooks Paginated
Declaration
PageWebhookProjection GetAllAccountWebhooks(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string eventType = null, string health = null, string searchFilter = 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) |
| DateTime? | since | Filter by created at after the given timestamp (optional) |
| DateTime? | before | Filter by created at before the given timestamp (optional) |
| string | eventType | Optional event type (optional) |
| string | health | Filter by webhook health (optional) |
| string | searchFilter | Optional search filter (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 |
GetAllAccountWebhooksWithHttpInfo(int?, int?, string, DateTime?, DateTime?, string, string, string, int)
List account webhooks Paginated
Declaration
ApiResponse<PageWebhookProjection> GetAllAccountWebhooksWithHttpInfo(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string eventType = null, string health = null, string searchFilter = 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) |
| DateTime? | since | Filter by created at after the given timestamp (optional) |
| DateTime? | before | Filter by created at before the given timestamp (optional) |
| string | eventType | Optional event type (optional) |
| string | health | Filter by webhook health (optional) |
| string | searchFilter | Optional search filter (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 |
GetAllWebhookEndpoints(int?, int?, string, string, DateTime?, Guid?, Guid?, DateTime?, string, string, int)
List Webhooks endpoints Paginated
Declaration
PageWebhookEndpointProjection GetAllWebhookEndpoints(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, Guid? inboxId = null, Guid? phoneId = null, DateTime? before = null, string health = null, string eventType = 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) |
| Guid? | inboxId | Filter by inboxId (optional) |
| Guid? | phoneId | Filter by phoneId (optional) |
| DateTime? | before | Filter by created at before the given timestamp (optional) |
| string | health | Filter by webhook health (optional) |
| string | eventType | Optional event type (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| PageWebhookEndpointProjection | PageWebhookEndpointProjection |
Remarks
List webhooks URL in paginated form. Allows for page index, page size, and sort direction.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetAllWebhookEndpointsWithHttpInfo(int?, int?, string, string, DateTime?, Guid?, Guid?, DateTime?, string, string, int)
List Webhooks endpoints Paginated
Declaration
ApiResponse<PageWebhookEndpointProjection> GetAllWebhookEndpointsWithHttpInfo(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, Guid? inboxId = null, Guid? phoneId = null, DateTime? before = null, string health = null, string eventType = 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) |
| Guid? | inboxId | Filter by inboxId (optional) |
| Guid? | phoneId | Filter by phoneId (optional) |
| DateTime? | before | Filter by created at before the given timestamp (optional) |
| string | health | Filter by webhook health (optional) |
| string | eventType | Optional event type (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<PageWebhookEndpointProjection> | ApiResponse of PageWebhookEndpointProjection |
Remarks
List webhooks URL in paginated form. Allows for page index, page size, and sort direction.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
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) |
| Guid? | inboxId | Inbox ID (optional) |
| Guid? | smsId | Sms ID (optional) |
| Guid? | attachmentId | Attachment ID (optional) |
| Guid? | emailId | Email ID (optional) |
| 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 |
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) |
| Guid? | inboxId | Inbox ID (optional) |
| Guid? | smsId | Sms ID (optional) |
| Guid? | attachmentId | Attachment ID (optional) |
| Guid? | emailId | Email ID (optional) |
| 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 |
GetAllWebhooks(int?, int?, string, string, DateTime?, Guid?, Guid?, DateTime?, string, string, string, 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, string health = null, string eventType = null, string url = 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) |
| Guid? | inboxId | Filter by inboxId (optional) |
| Guid? | phoneId | Filter by phoneId (optional) |
| DateTime? | before | Filter by created at before the given timestamp (optional) |
| string | health | Filter by webhook health (optional) |
| string | eventType | Optional event type (optional) |
| string | url | Optional url endpoint filter (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 |
GetAllWebhooksWithHttpInfo(int?, int?, string, string, DateTime?, Guid?, Guid?, DateTime?, string, string, string, 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, string health = null, string eventType = null, string url = 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) |
| Guid? | inboxId | Filter by inboxId (optional) |
| Guid? | phoneId | Filter by phoneId (optional) |
| DateTime? | before | Filter by created at before the given timestamp (optional) |
| string | health | Filter by webhook health (optional) |
| string | eventType | Optional event type (optional) |
| string | url | Optional url endpoint filter (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 |
GetInboxWebhooksPaginated(Guid, int?, int?, string, string, DateTime?, DateTime?, string, string, 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, string health = null, string eventType = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| 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) |
| string | health | Filter by webhook health (optional) |
| string | eventType | Optional event type (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| PageWebhookProjection | PageWebhookProjection |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetInboxWebhooksPaginatedWithHttpInfo(Guid, int?, int?, string, string, DateTime?, DateTime?, string, string, 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, string health = null, string eventType = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| 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) |
| string | health | Filter by webhook health (optional) |
| string | eventType | Optional event type (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 |
GetJsonSchemaForWebhookEvent(string, int)
Declaration
JSONSchemaDto GetJsonSchemaForWebhookEvent(string varEvent, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| string | varEvent | |
| 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 |
GetJsonSchemaForWebhookEventWithHttpInfo(string, int)
Declaration
ApiResponse<JSONSchemaDto> GetJsonSchemaForWebhookEventWithHttpInfo(string varEvent, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| string | varEvent | |
| 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 |
GetJsonSchemaForWebhookPayload(Guid, int)
Declaration
JSONSchemaDto GetJsonSchemaForWebhookPayload(Guid webhookId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| 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 |
GetJsonSchemaForWebhookPayloadWithHttpInfo(Guid, int)
Declaration
ApiResponse<JSONSchemaDto> GetJsonSchemaForWebhookPayloadWithHttpInfo(Guid webhookId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| 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 |
GetPhoneNumberWebhooksPaginated(Guid, int?, int?, string, DateTime?, DateTime?, string, string, string, 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, string eventType = null, string searchFilter = null, string health = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| 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) |
| string | eventType | Optional event type (optional) |
| string | searchFilter | Optional search filter (optional) |
| string | health | Filter by webhook health (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| PageWebhookProjection | PageWebhookProjection |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetPhoneNumberWebhooksPaginatedWithHttpInfo(Guid, int?, int?, string, DateTime?, DateTime?, string, string, string, 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, string eventType = null, string searchFilter = null, string health = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| 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) |
| string | eventType | Optional event type (optional) |
| string | searchFilter | Optional search filter (optional) |
| string | health | Filter by webhook health (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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
GetTestWebhookPayloadForWebhook(Guid, int)
Declaration
AbstractWebhookPayload GetTestWebhookPayloadForWebhook(Guid webhookId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| 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 |
GetTestWebhookPayloadForWebhookWithHttpInfo(Guid, int)
Declaration
ApiResponse<AbstractWebhookPayload> GetTestWebhookPayloadForWebhookWithHttpInfo(Guid webhookId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| 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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
GetWebhook(Guid, int)
Get a webhook
Declaration
WebhookDto GetWebhook(Guid webhookId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| 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 |
GetWebhookResult(Guid, int)
Get a webhook result for a webhook
Declaration
WebhookResultDto GetWebhookResult(Guid webhookResultId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| 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 |
GetWebhookResultWithHttpInfo(Guid, int)
Get a webhook result for a webhook
Declaration
ApiResponse<WebhookResultDto> GetWebhookResultWithHttpInfo(Guid webhookResultId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| 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 |
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 |
|---|---|---|
| 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) |
| Guid? | inboxId | Inbox ID (optional) |
| Guid? | smsId | Sms ID (optional) |
| Guid? | attachmentId | Attachment ID (optional) |
| Guid? | emailId | Email ID (optional) |
| 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 |
GetWebhookResultsCount(Guid, int)
Get a webhook results count for a webhook
Declaration
CountDto GetWebhookResultsCount(Guid webhookId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| 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 |
GetWebhookResultsCountWithHttpInfo(Guid, int)
Get a webhook results count for a webhook
Declaration
ApiResponse<CountDto> GetWebhookResultsCountWithHttpInfo(Guid webhookId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| 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 |
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 |
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 |
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 |
|---|---|---|
| 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) |
| Guid? | inboxId | Inbox ID (optional) |
| Guid? | smsId | Sms ID (optional) |
| Guid? | attachmentId | Attachment ID (optional) |
| Guid? | emailId | Email ID (optional) |
| 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 |
GetWebhookWithHttpInfo(Guid, int)
Get a webhook
Declaration
ApiResponse<WebhookDto> GetWebhookWithHttpInfo(Guid webhookId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| 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 |
GetWebhooks(Guid, int?, int?, string, int)
Get all webhooks for an Inbox
Declaration
[Obsolete]
List<WebhookProjection> GetWebhooks(Guid inboxId, int? page = null, int? size = null, string sort = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| 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) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| List<WebhookProjection> | List<WebhookProjection> |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetWebhooksWithHttpInfo(Guid, int?, int?, string, int)
Get all webhooks for an Inbox
Declaration
[Obsolete]
ApiResponse<List<WebhookProjection>> GetWebhooksWithHttpInfo(Guid inboxId, int? page = null, int? size = null, string sort = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| 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) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<List<WebhookProjection>> | ApiResponse of List<WebhookProjection> |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
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 |
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 |
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 |
|---|---|---|
| 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 |
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 |
|---|---|---|
| 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 |
SendTestData(Guid, int)
Send webhook test data
Declaration
WebhookTestResult SendTestData(Guid webhookId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| 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 |
SendTestDataWithHttpInfo(Guid, int)
Send webhook test data
Declaration
ApiResponse<WebhookTestResult> SendTestDataWithHttpInfo(Guid webhookId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| 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 |
UpdateWebhook(Guid, CreateWebhookOptions, Guid?, Guid?, bool?, int)
Update a webhook
Declaration
WebhookDto UpdateWebhook(Guid webhookId, CreateWebhookOptions createWebhookOptions, Guid? inboxId = null, Guid? phoneNumberId = null, bool? overrideAuth = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | webhookId | |
| CreateWebhookOptions | createWebhookOptions | |
| Guid? | inboxId | (optional) |
| Guid? | phoneNumberId | (optional) |
| bool? | overrideAuth | (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| WebhookDto | WebhookDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
UpdateWebhookHeaders(Guid, WebhookHeaders, int)
Update a webhook request headers
Declaration
WebhookDto UpdateWebhookHeaders(Guid webhookId, WebhookHeaders webhookHeaders, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| 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 |
UpdateWebhookHeadersWithHttpInfo(Guid, WebhookHeaders, int)
Update a webhook request headers
Declaration
ApiResponse<WebhookDto> UpdateWebhookHeadersWithHttpInfo(Guid webhookId, WebhookHeaders webhookHeaders, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| 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 |
UpdateWebhookWithHttpInfo(Guid, CreateWebhookOptions, Guid?, Guid?, bool?, int)
Update a webhook
Declaration
ApiResponse<WebhookDto> UpdateWebhookWithHttpInfo(Guid webhookId, CreateWebhookOptions createWebhookOptions, Guid? inboxId = null, Guid? phoneNumberId = null, bool? overrideAuth = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | webhookId | |
| CreateWebhookOptions | createWebhookOptions | |
| Guid? | inboxId | (optional) |
| Guid? | phoneNumberId | (optional) |
| bool? | overrideAuth | (optional) |
| 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 |
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 |
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 |
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 |
|---|---|---|
| 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 |
|---|---|
| List<WebhookResultDto> | List<WebhookResultDto> |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
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 |
|---|---|---|
| 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<List<WebhookResultDto>> | ApiResponse of List<WebhookResultDto> |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |