mailslurp.api.WebhookControllerApi
Load the API package
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
createAccountWebhook | POST /webhooks | Attach a WebHook URL to an inbox |
createWebhook | POST /inboxes/{inboxId}/webhooks | Attach a WebHook URL to an inbox |
createWebhookForPhoneNumber | POST /phone/numbers/{phoneNumberId}/webhooks | Attach a WebHook URL to a phone number |
deleteAllWebhooks | DELETE /webhooks | Delete all webhooks |
deleteWebhook | DELETE /inboxes/{inboxId}/webhooks/{webhookId} | Delete and disable a Webhook for an Inbox |
deleteWebhookById | DELETE /webhooks/{webhookId} | Delete a webhook |
getAllAccountWebhooks | GET /webhooks/account/paginated | List account webhooks Paginated |
getAllWebhookResults | GET /webhooks/results | Get results for all webhooks |
getAllWebhooks | GET /webhooks/paginated | List Webhooks Paginated |
getInboxWebhooksPaginated | GET /inboxes/{inboxId}/webhooks/paginated | Get paginated webhooks for an Inbox |
getJsonSchemaForWebhookEvent | POST /webhooks/schema | |
getJsonSchemaForWebhookPayload | POST /webhooks/{webhookId}/schema | |
getPhoneNumberWebhooksPaginated | GET /phone/numbers/{phoneId}/webhooks/paginated | Get paginated webhooks for a phone number |
getTestWebhookPayload | GET /webhooks/test | |
getTestWebhookPayloadBounce | GET /webhooks/test/email-bounce-payload | |
getTestWebhookPayloadBounceRecipient | GET /webhooks/test/email-bounce-recipient-payload | |
getTestWebhookPayloadDeliveryStatus | GET /webhooks/test/delivery-status-payload | Get webhook test payload for delivery status event |
getTestWebhookPayloadEmailOpened | GET /webhooks/test/email-opened-payload | |
getTestWebhookPayloadEmailRead | GET /webhooks/test/email-read-payload | |
getTestWebhookPayloadForWebhook | POST /webhooks/{webhookId}/example | |
getTestWebhookPayloadNewAttachment | GET /webhooks/test/new-attachment-payload | Get webhook test payload for new attachment event |
getTestWebhookPayloadNewContact | GET /webhooks/test/new-contact-payload | Get webhook test payload for new contact event |
getTestWebhookPayloadNewEmail | GET /webhooks/test/new-email-payload | Get webhook test payload for new email event |
getTestWebhookPayloadNewSms | GET /webhooks/test/new-sms-payload | Get webhook test payload for new sms event |
getWebhook | GET /webhooks/{webhookId} | Get a webhook |
getWebhookResult | GET /webhooks/results/{webhookResultId} | Get a webhook result for a webhook |
getWebhookResults | GET /webhooks/{webhookId}/results | Get a webhook results for a webhook |
getWebhookResultsUnseenErrorCount | GET /webhooks/results/unseen-count | Get count of unseen webhook results with error status |
getWebhooks | GET /inboxes/{inboxId}/webhooks | Get all webhooks for an Inbox |
redriveWebhookResult | POST /webhooks/results/{webhookResultId}/redrive | Get a webhook result and try to resend the original webhook payload |
sendTestData | POST /webhooks/{webhookId}/test | Send webhook test data |
updateWebhookHeaders | PUT /webhooks/{webhookId}/headers | Update a webhook request headers |
verifyWebhookSignature | POST /webhooks/verify | Verify a webhook payload signature |
WebhookDto createAccountWebhook(createWebhookOptions)
Attach a WebHook URL to an inbox
Get notified of account level events such as bounce and bounce recipient.
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final createWebhookOptions = CreateWebhookOptions(); // CreateWebhookOptions |
try {
final result = api_instance.createAccountWebhook(createWebhookOptions);
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->createAccountWebhook: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
createWebhookOptions | CreateWebhookOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
WebhookDto createWebhook(inboxId, createWebhookOptions)
Attach a WebHook URL to an inbox
Get notified whenever an inbox receives an email via a WebHook URL. An emailID will be posted to this URL every time an email is received for this inbox. The URL must be publicly reachable by the MailSlurp server. You can provide basicAuth values if you wish to secure this endpoint.
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final inboxId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final createWebhookOptions = CreateWebhookOptions(); // CreateWebhookOptions |
try {
final result = api_instance.createWebhook(inboxId, createWebhookOptions);
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->createWebhook: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inboxId | String | ||
createWebhookOptions | CreateWebhookOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
WebhookDto createWebhookForPhoneNumber(phoneNumberId, createWebhookOptions)
Attach a WebHook URL to a phone number
Get notified whenever a phone number receives an SMS via a WebHook URL.
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final phoneNumberId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final createWebhookOptions = CreateWebhookOptions(); // CreateWebhookOptions |
try {
final result = api_instance.createWebhookForPhoneNumber(phoneNumberId, createWebhookOptions);
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->createWebhookForPhoneNumber: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
phoneNumberId | String | ||
createWebhookOptions | CreateWebhookOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
deleteAllWebhooks(before)
Delete all webhooks
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final before = 2013-10-20T19:20:30+01:00; // DateTime | before
try {
api_instance.deleteAllWebhooks(before);
} catch (e) {
print('Exception when calling WebhookControllerApi->deleteAllWebhooks: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
before | DateTime | before | [optional] |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to ]
deleteWebhook(inboxId, webhookId)
Delete and disable a Webhook for an Inbox
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final inboxId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final webhookId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
try {
api_instance.deleteWebhook(inboxId, webhookId);
} catch (e) {
print('Exception when calling WebhookControllerApi->deleteWebhook: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inboxId | String | ||
webhookId | String |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to ]
deleteWebhookById(webhookId)
Delete a webhook
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final webhookId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
try {
api_instance.deleteWebhookById(webhookId);
} catch (e) {
print('Exception when calling WebhookControllerApi->deleteWebhookById: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
webhookId | String |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to ]
PageWebhookProjection getAllAccountWebhooks(page, size, sort, eventType, since, before)
List account webhooks Paginated
List account webhooks in paginated form. Allows for page , page size, and sort direction.
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final page = 56; // int | Optional page in list pagination
final size = 56; // int | Optional page size for paginated result list.
final sort = sort_example; // String | Optional createdAt sort direction ASC or DESC
final eventType = eventType_example; // String | Optional event type
final since = 2013-10-20T19:20:30+01:00; // DateTime | Filter by created at after the given timestamp
final before = 2013-10-20T19:20:30+01:00; // DateTime | Filter by created at before the given timestamp
try {
final result = api_instance.getAllAccountWebhooks(page, size, sort, eventType, since, before);
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getAllAccountWebhooks: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
page | int | Optional page in list pagination | [optional] [default to 0] |
size | int | Optional page size for paginated result list. | [optional] [default to 20] |
sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to 'DESC'] |
eventType | String | Optional event type | [optional] |
since | DateTime | Filter by created at after the given timestamp | [optional] |
before | DateTime | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
PageWebhookResult getAllWebhookResults(page, size, sort, searchFilter, since, before, unseenOnly)
Get results for all webhooks
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final page = 56; // int | Optional page in list pagination
final size = 56; // int | Optional page size in list pagination
final sort = sort_example; // String | Optional createdAt sort direction ASC or DESC
final searchFilter = searchFilter_example; // String | Optional search filter
final since = 2013-10-20T19:20:30+01:00; // DateTime | Filter by created at after the given timestamp
final before = 2013-10-20T19:20:30+01:00; // DateTime | Filter by created at before the given timestamp
final unseenOnly = true; // bool | Filter for unseen exceptions only
try {
final result = api_instance.getAllWebhookResults(page, size, sort, searchFilter, since, before, unseenOnly);
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getAllWebhookResults: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
page | int | Optional page in list pagination | [optional] [default to 0] |
size | int | Optional page size in list pagination | [optional] [default to 20] |
sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to 'ASC'] |
searchFilter | String | Optional search filter | [optional] |
since | DateTime | Filter by created at after the given timestamp | [optional] |
before | DateTime | Filter by created at before the given timestamp | [optional] |
unseenOnly | bool | Filter for unseen exceptions only | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
PageWebhookProjection getAllWebhooks(page, size, sort, searchFilter, since, inboxId, phoneId, before)
List Webhooks Paginated
List webhooks in paginated form. Allows for page , page size, and sort direction.
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final page = 56; // int | Optional page in list pagination
final size = 56; // int | Optional page size for paginated result list.
final sort = sort_example; // String | Optional createdAt sort direction ASC or DESC
final searchFilter = searchFilter_example; // String | Optional search filter
final since = 2013-10-20T19:20:30+01:00; // DateTime | Filter by created at after the given timestamp
final inboxId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Filter by inboxId
final phoneId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Filter by phoneId
final before = 2013-10-20T19:20:30+01:00; // DateTime | Filter by created at before the given timestamp
try {
final result = api_instance.getAllWebhooks(page, size, sort, searchFilter, since, inboxId, phoneId, before);
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getAllWebhooks: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
page | int | Optional page in list pagination | [optional] [default to 0] |
size | int | Optional page size for paginated result list. | [optional] [default to 20] |
sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to 'DESC'] |
searchFilter | String | Optional search filter | [optional] |
since | DateTime | Filter by created at after the given timestamp | [optional] |
inboxId | String | Filter by inboxId | [optional] |
phoneId | String | Filter by phoneId | [optional] |
before | DateTime | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
PageWebhookProjection getInboxWebhooksPaginated(inboxId, page, size, sort, searchFilter, since, before)
Get paginated webhooks for an Inbox
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final inboxId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final page = 56; // int | Optional page in list pagination
final size = 56; // int | Optional page size in list pagination
final sort = sort_example; // String | Optional createdAt sort direction ASC or DESC
final searchFilter = searchFilter_example; // String | Optional search filter
final since = 2013-10-20T19:20:30+01:00; // DateTime | Filter by created at after the given timestamp
final before = 2013-10-20T19:20:30+01:00; // DateTime | Filter by created at before the given timestamp
try {
final result = api_instance.getInboxWebhooksPaginated(inboxId, page, size, sort, searchFilter, since, before);
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getInboxWebhooksPaginated: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inboxId | String | ||
page | int | Optional page in list pagination | [optional] [default to 0] |
size | int | Optional page size in list pagination | [optional] [default to 20] |
sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to 'ASC'] |
searchFilter | String | Optional search filter | [optional] |
since | DateTime | Filter by created at after the given timestamp | [optional] |
before | DateTime | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
JSONSchemaDto getJsonSchemaForWebhookEvent(event)
Get JSON Schema definition for webhook payload by event
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final event = event_example; // String |
try {
final result = api_instance.getJsonSchemaForWebhookEvent(event);
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getJsonSchemaForWebhookEvent: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
event | String |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
JSONSchemaDto getJsonSchemaForWebhookPayload(webhookId)
Get JSON Schema definition for webhook payload
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final webhookId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
try {
final result = api_instance.getJsonSchemaForWebhookPayload(webhookId);
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getJsonSchemaForWebhookPayload: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
webhookId | String |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
PageWebhookProjection getPhoneNumberWebhooksPaginated(phoneId, page, size, sort, since, before)
Get paginated webhooks for a phone number
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final phoneId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final page = 56; // int | Optional page in list pagination
final size = 56; // int | Optional page size in list pagination
final sort = sort_example; // String | Optional createdAt sort direction ASC or DESC
final since = 2013-10-20T19:20:30+01:00; // DateTime | Filter by created at after the given timestamp
final before = 2013-10-20T19:20:30+01:00; // DateTime | Filter by created at before the given timestamp
try {
final result = api_instance.getPhoneNumberWebhooksPaginated(phoneId, page, size, sort, since, before);
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getPhoneNumberWebhooksPaginated: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
phoneId | String | ||
page | int | Optional page in list pagination | [optional] [default to 0] |
size | int | Optional page size in list pagination | [optional] [default to 20] |
sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to 'ASC'] |
since | DateTime | Filter by created at after the given timestamp | [optional] |
before | DateTime | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
AbstractWebhookPayload getTestWebhookPayload(eventName)
Get test webhook payload example. Response content depends on eventName passed. Uses EMAIL_RECEIVED
as default.
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final eventName = eventName_example; // String |
try {
final result = api_instance.getTestWebhookPayload(eventName);
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getTestWebhookPayload: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
eventName | String | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
WebhookBouncePayload getTestWebhookPayloadBounce()
Get webhook test payload for bounce
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
try {
final result = api_instance.getTestWebhookPayloadBounce();
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getTestWebhookPayloadBounce: $en');
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
WebhookBounceRecipientPayload getTestWebhookPayloadBounceRecipient()
Get webhook test payload for bounce recipient
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
try {
final result = api_instance.getTestWebhookPayloadBounceRecipient();
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getTestWebhookPayloadBounceRecipient: $en');
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
WebhookDeliveryStatusPayload getTestWebhookPayloadDeliveryStatus()
Get webhook test payload for delivery status event
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
try {
final result = api_instance.getTestWebhookPayloadDeliveryStatus();
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getTestWebhookPayloadDeliveryStatus: $en');
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
WebhookEmailOpenedPayload getTestWebhookPayloadEmailOpened()
Get webhook test payload for email opened event
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
try {
final result = api_instance.getTestWebhookPayloadEmailOpened();
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getTestWebhookPayloadEmailOpened: $en');
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
WebhookEmailReadPayload getTestWebhookPayloadEmailRead()
Get webhook test payload for email opened event
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
try {
final result = api_instance.getTestWebhookPayloadEmailRead();
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getTestWebhookPayloadEmailRead: $en');
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
AbstractWebhookPayload getTestWebhookPayloadForWebhook(webhookId)
Get example payload for webhook
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final webhookId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
try {
final result = api_instance.getTestWebhookPayloadForWebhook(webhookId);
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getTestWebhookPayloadForWebhook: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
webhookId | String |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
WebhookNewAttachmentPayload getTestWebhookPayloadNewAttachment()
Get webhook test payload for new attachment event
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
try {
final result = api_instance.getTestWebhookPayloadNewAttachment();
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getTestWebhookPayloadNewAttachment: $en');
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
WebhookNewContactPayload getTestWebhookPayloadNewContact()
Get webhook test payload for new contact event
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
try {
final result = api_instance.getTestWebhookPayloadNewContact();
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getTestWebhookPayloadNewContact: $en');
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
WebhookNewEmailPayload getTestWebhookPayloadNewEmail()
Get webhook test payload for new email event
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
try {
final result = api_instance.getTestWebhookPayloadNewEmail();
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getTestWebhookPayloadNewEmail: $en');
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
WebhookNewSmsPayload getTestWebhookPayloadNewSms()
Get webhook test payload for new sms event
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
try {
final result = api_instance.getTestWebhookPayloadNewSms();
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getTestWebhookPayloadNewSms: $en');
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
WebhookDto getWebhook(webhookId)
Get a webhook
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final webhookId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
try {
final result = api_instance.getWebhook(webhookId);
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getWebhook: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
webhookId | String |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
WebhookResultDto getWebhookResult(webhookResultId)
Get a webhook result for a webhook
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final webhookResultId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Webhook Result ID
try {
final result = api_instance.getWebhookResult(webhookResultId);
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getWebhookResult: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
webhookResultId | String | Webhook Result ID |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
PageWebhookResult getWebhookResults(webhookId, page, size, sort, searchFilter, since, before, unseenOnly)
Get a webhook results for a webhook
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final webhookId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | ID of webhook to get results for
final page = 56; // int | Optional page in list pagination
final size = 56; // int | Optional page size in list pagination
final sort = sort_example; // String | Optional createdAt sort direction ASC or DESC
final searchFilter = searchFilter_example; // String | Optional search filter
final since = 2013-10-20T19:20:30+01:00; // DateTime | Filter by created at after the given timestamp
final before = 2013-10-20T19:20:30+01:00; // DateTime | Filter by created at before the given timestamp
final unseenOnly = true; // bool | Filter for unseen exceptions only
try {
final result = api_instance.getWebhookResults(webhookId, page, size, sort, searchFilter, since, before, unseenOnly);
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getWebhookResults: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
webhookId | String | ID of webhook to get results for | |
page | int | Optional page in list pagination | [optional] [default to 0] |
size | int | Optional page size in list pagination | [optional] [default to 20] |
sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to 'ASC'] |
searchFilter | String | Optional search filter | [optional] |
since | DateTime | Filter by created at after the given timestamp | [optional] |
before | DateTime | Filter by created at before the given timestamp | [optional] |
unseenOnly | bool | Filter for unseen exceptions only | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
UnseenErrorCountDto getWebhookResultsUnseenErrorCount()
Get count of unseen webhook results with error status
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
try {
final result = api_instance.getWebhookResultsUnseenErrorCount();
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getWebhookResultsUnseenErrorCount: $en');
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
List
getWebhooks(inboxId)
Get all webhooks for an Inbox
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final inboxId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
try {
final result = api_instance.getWebhooks(inboxId);
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->getWebhooks: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
inboxId | String |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
WebhookRedriveResult redriveWebhookResult(webhookResultId)
Get a webhook result and try to resend the original webhook payload
Allows you to resend a webhook payload that was already sent. Webhooks that fail are retried automatically for 24 hours and then put in a dead letter queue. You can retry results manually using this method.
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final webhookResultId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Webhook Result ID
try {
final result = api_instance.redriveWebhookResult(webhookResultId);
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->redriveWebhookResult: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
webhookResultId | String | Webhook Result ID |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
WebhookTestResult sendTestData(webhookId)
Send webhook test data
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final webhookId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
try {
final result = api_instance.sendTestData(webhookId);
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->sendTestData: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
webhookId | String |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
WebhookDto updateWebhookHeaders(webhookId, webhookHeaders)
Update a webhook request headers
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final webhookId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final webhookHeaders = WebhookHeaders(); // WebhookHeaders |
try {
final result = api_instance.updateWebhookHeaders(webhookId, webhookHeaders);
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->updateWebhookHeaders: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
webhookId | String | ||
webhookHeaders | WebhookHeaders |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
VerifyWebhookSignatureResults verifyWebhookSignature(verifyWebhookSignatureOptions)
Verify a webhook payload signature
Verify a webhook payload using the messageId and signature. This allows you to be sure that MailSlurp sent the payload and not another server.
Example
import 'package:mailslurp/api.dart';
// TODO Configure API key authorization: API_KEY
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('API_KEY').apiKeyPrefix = 'Bearer';
final api_instance = WebhookControllerApi();
final verifyWebhookSignatureOptions = VerifyWebhookSignatureOptions(); // VerifyWebhookSignatureOptions |
try {
final result = api_instance.verifyWebhookSignature(verifyWebhookSignatureOptions);
print(result);
} catch (e) {
print('Exception when calling WebhookControllerApi->verifyWebhookSignature: $en');
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
verifyWebhookSignatureOptions | VerifyWebhookSignatureOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]