All URIs are relative to https://api.mailslurp.comMethodHTTP requestDescriptioncreateWebhookPOST /inboxes/{inboxId}/webhooksAttach a WebHook URL to an inboxdeleteAllWebhooksDELETE /webhooksDelete all webhooksdeleteWebhookDELETE /inboxes/{inboxId}/webhooks/{webhookId}Delete and disable a Webhook for an InboxgetAllWebhookResultsGET /webhooks/resultsGet results for all webhooksgetAllWebhooksGET /webhooks/paginatedList Webhooks PaginatedgetInboxWebhooksPaginatedGET /inboxes/{inboxId}/webhooks/paginatedGet paginated webhooks for an InboxgetJsonSchemaForWebhookPayloadPOST /webhooks/{webhookId}/schemagetTestWebhookPayloadGET /webhooks/testgetTestWebhookPayloadEmailOpenedGET /webhooks/test/email-opened-payloadgetTestWebhookPayloadEmailReadGET /webhooks/test/email-read-payloadgetTestWebhookPayloadForWebhookPOST /webhooks/{webhookId}/examplegetTestWebhookPayloadNewAttachmentGET /webhooks/test/new-attachment-payloadGet webhook test payload for new attachment eventgetTestWebhookPayloadNewContactGET /webhooks/test/new-contact-payloadGet webhook test payload for new contact eventgetTestWebhookPayloadNewEmailGET /webhooks/test/new-email-payloadGet webhook test payload for new email eventgetWebhookGET /webhooks/{webhookId}Get a webhook for an InboxgetWebhookResultGET /webhooks/results/{webhookResultId}Get a webhook result for a webhookgetWebhookResultsGET /webhooks/{webhookId}/resultsGet a webhook results for a webhookgetWebhookResultsUnseenErrorCountGET /webhooks/results/unseen-countGet count of unseen webhook results with error statusgetWebhooksGET /inboxes/{inboxId}/webhooksGet all webhooks for an InboxredriveWebhookResultPOST /webhooks/results/{webhookResultId}/redriveGet a webhook result and try to resend the original webhook payloadsendTestDataPOST /webhooks/{webhookId}/testSend webhook test datacreateWebhookMailSlurpModelsWebhookDto createWebhook($inbox_id, $create_webhook_options)Attach a WebHook URL to an inboxGet 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<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: API_KEY $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer'); $apiInstance = new MailSlurpApiWebhookControllerApi( // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`. // This is optional, `GuzzleHttpClient` will be used as default. new GuzzleHttpClient(), $config ); $inbox_id = 'inbox_id_example'; // string | $create_webhook_options = new MailSlurpModelsCreateWebhookOptions(); // MailSlurpModelsCreateWebhookOptions | try { $result = $apiInstance->createWebhook($inbox_id, $create_webhook_options); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhookControllerApi->createWebhook: ', $e->getMessage(), PHP_EOL; } ?> ParametersNameTypeDescriptionNotesinbox_idstringcreate_webhook_optionsMailSlurpModelsCreateWebhookOptionsReturn typeMailSlurpModelsWebhookDtoAuthorizationAPI_KEYHTTP request headersContent-Type: application/jsonAccept: /[Back to top] [Back to API list] [Back to Model list] [Back to ]deleteAllWebhooksdeleteAllWebhooks()Delete all webhooksExample<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: API_KEY $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer'); $apiInstance = new MailSlurpApiWebhookControllerApi( // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`. // This is optional, `GuzzleHttpClient` will be used as default. new GuzzleHttpClient(), $config ); try { $apiInstance->deleteAllWebhooks(); } catch (Exception $e) { echo 'Exception when calling WebhookControllerApi->deleteAllWebhooks: ', $e->getMessage(), PHP_EOL; } ?> ParametersThis endpoint does not need any parameter.Return typevoid (empty response body)AuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: Not defined[Back to top] [Back to API list] [Back to Model list] [Back to ]deleteWebhookdeleteWebhook($inbox_id, $webhook_id)Delete and disable a Webhook for an InboxExample<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: API_KEY $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer'); $apiInstance = new MailSlurpApiWebhookControllerApi( // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`. // This is optional, `GuzzleHttpClient` will be used as default. new GuzzleHttpClient(), $config ); $inbox_id = 'inbox_id_example'; // string | $webhook_id = 'webhook_id_example'; // string | try { $apiInstance->deleteWebhook($inbox_id, $webhook_id); } catch (Exception $e) { echo 'Exception when calling WebhookControllerApi->deleteWebhook: ', $e->getMessage(), PHP_EOL; } ?> ParametersNameTypeDescriptionNotesinbox_idstringwebhook_idstringReturn typevoid (empty response body)AuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: Not defined[Back to top] [Back to API list] [Back to Model list] [Back to ]getAllWebhookResultsMailSlurpModelsPageWebhookResult getAllWebhookResults($page, $size, $sort, $search_filter, $since, $before, $unseen_only)Get results for all webhooksExample<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: API_KEY $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer'); $apiInstance = new MailSlurpApiWebhookControllerApi( // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`. // This is optional, `GuzzleHttpClient` will be used as default. new GuzzleHttpClient(), $config ); $page = 0; // int | Optional page in list pagination $size = 20; // int | Optional page size in list pagination $sort = 'ASC'; // string | Optional createdAt sort direction ASC or DESC $search_filter = 'search_filter_example'; // string | Optional search filter $since = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | Filter by created at after the given timestamp $before = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | Filter by created at before the given timestamp $unseen_only = True; // bool | Filter for unseen exceptions only try { $result = $apiInstance->getAllWebhookResults($page, $size, $sort, $search_filter, $since, $before, $unseen_only); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhookControllerApi->getAllWebhookResults: ', $e->getMessage(), PHP_EOL; } ?> ParametersNameTypeDescriptionNotespageintOptional page in list pagination[optional] [default to 0]sizeintOptional page size in list pagination[optional] [default to 20]sortstringOptional createdAt sort direction ASC or DESC[optional] [default to ‘ASC’]search_filterstringOptional search filter[optional]sinceDateTimeFilter by created at after the given timestamp[optional]beforeDateTimeFilter by created at before the given timestamp[optional]unseen_onlyboolFilter for unseen exceptions only[optional]Return typeMailSlurpModelsPageWebhookResultAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: /[Back to top] [Back to API list] [Back to Model list] [Back to ]getAllWebhooksMailSlurpModelsPageWebhookProjection getAllWebhooks($page, $size, $sort, $search_filter, $since, $before)List Webhooks PaginatedList webhooks in paginated form. Allows for page , page size, and sort direction.Example<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: API_KEY $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer'); $apiInstance = new MailSlurpApiWebhookControllerApi( // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`. // This is optional, `GuzzleHttpClient` will be used as default. new GuzzleHttpClient(), $config ); $page = 0; // int | Optional page in list pagination $size = 20; // int | Optional page size for paginated result list. $sort = 'DESC'; // string | Optional createdAt sort direction ASC or DESC $search_filter = 'search_filter_example'; // string | Optional search filter $since = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | Filter by created at after the given timestamp $before = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | Filter by created at before the given timestamp try { $result = $apiInstance->getAllWebhooks($page, $size, $sort, $search_filter, $since, $before); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhookControllerApi->getAllWebhooks: ', $e->getMessage(), PHP_EOL; } ?> ParametersNameTypeDescriptionNotespageintOptional page in list pagination[optional] [default to 0]sizeintOptional page size for paginated result list.[optional] [default to 20]sortstringOptional createdAt sort direction ASC or DESC[optional] [default to ‘DESC’]search_filterstringOptional search filter[optional]sinceDateTimeFilter by created at after the given timestamp[optional]beforeDateTimeFilter by created at before the given timestamp[optional]Return typeMailSlurpModelsPageWebhookProjectionAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: /[Back to top] [Back to API list] [Back to Model list] [Back to ]getInboxWebhooksPaginatedMailSlurpModelsPageWebhookProjection getInboxWebhooksPaginated($inbox_id, $page, $size, $sort, $search_filter, $since, $before)Get paginated webhooks for an InboxExample<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: API_KEY $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer'); $apiInstance = new MailSlurpApiWebhookControllerApi( // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`. // This is optional, `GuzzleHttpClient` will be used as default. new GuzzleHttpClient(), $config ); $inbox_id = 'inbox_id_example'; // string | $page = 0; // int | Optional page in list pagination $size = 20; // int | Optional page size in list pagination $sort = 'ASC'; // string | Optional createdAt sort direction ASC or DESC $search_filter = 'search_filter_example'; // string | Optional search filter $since = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | Filter by created at after the given timestamp $before = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | Filter by created at before the given timestamp try { $result = $apiInstance->getInboxWebhooksPaginated($inbox_id, $page, $size, $sort, $search_filter, $since, $before); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhookControllerApi->getInboxWebhooksPaginated: ', $e->getMessage(), PHP_EOL; } ?> ParametersNameTypeDescriptionNotesinbox_idstringpageintOptional page in list pagination[optional] [default to 0]sizeintOptional page size in list pagination[optional] [default to 20]sortstringOptional createdAt sort direction ASC or DESC[optional] [default to ‘ASC’]search_filterstringOptional search filter[optional]sinceDateTimeFilter by created at after the given timestamp[optional]beforeDateTimeFilter by created at before the given timestamp[optional]Return typeMailSlurpModelsPageWebhookProjectionAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: /[Back to top] [Back to API list] [Back to Model list] [Back to ]getJsonSchemaForWebhookPayloadMailSlurpModelsJSONSchemaDto getJsonSchemaForWebhookPayload($webhook_id)Get JSON Schema definition for webhook payloadExample<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: API_KEY $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer'); $apiInstance = new MailSlurpApiWebhookControllerApi( // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`. // This is optional, `GuzzleHttpClient` will be used as default. new GuzzleHttpClient(), $config ); $webhook_id = 'webhook_id_example'; // string | try { $result = $apiInstance->getJsonSchemaForWebhookPayload($webhook_id); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhookControllerApi->getJsonSchemaForWebhookPayload: ', $e->getMessage(), PHP_EOL; } ?> ParametersNameTypeDescriptionNoteswebhook_idstringReturn typeMailSlurpModelsJSONSchemaDtoAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: /[Back to top] [Back to API list] [Back to Model list] [Back to ]getTestWebhookPayloadMailSlurpModelsAbstractWebhookPayload getTestWebhookPayload($event_name)Get test webhook payload example. Response content depends on eventName passed. Uses EMAIL_RECEIVED as default.Example<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: API_KEY $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer'); $apiInstance = new MailSlurpApiWebhookControllerApi( // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`. // This is optional, `GuzzleHttpClient` will be used as default. new GuzzleHttpClient(), $config ); $event_name = 'event_name_example'; // string | try { $result = $apiInstance->getTestWebhookPayload($event_name); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhookControllerApi->getTestWebhookPayload: ', $e->getMessage(), PHP_EOL; } ?> ParametersNameTypeDescriptionNotesevent_namestring[optional]Return typeMailSlurpModelsAbstractWebhookPayloadAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: /[Back to top] [Back to API list] [Back to Model list] [Back to ]getTestWebhookPayloadEmailOpenedMailSlurpModelsWebhookEmailOpenedPayload getTestWebhookPayloadEmailOpened()Get webhook test payload for email opened eventExample<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: API_KEY $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer'); $apiInstance = new MailSlurpApiWebhookControllerApi( // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`. // This is optional, `GuzzleHttpClient` will be used as default. new GuzzleHttpClient(), $config ); try { $result = $apiInstance->getTestWebhookPayloadEmailOpened(); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhookControllerApi->getTestWebhookPayloadEmailOpened: ', $e->getMessage(), PHP_EOL; } ?> ParametersThis endpoint does not need any parameter.Return typeMailSlurpModelsWebhookEmailOpenedPayloadAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: /[Back to top] [Back to API list] [Back to Model list] [Back to ]getTestWebhookPayloadEmailReadMailSlurpModelsWebhookEmailReadPayload getTestWebhookPayloadEmailRead()Get webhook test payload for email opened eventExample<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: API_KEY $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer'); $apiInstance = new MailSlurpApiWebhookControllerApi( // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`. // This is optional, `GuzzleHttpClient` will be used as default. new GuzzleHttpClient(), $config ); try { $result = $apiInstance->getTestWebhookPayloadEmailRead(); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhookControllerApi->getTestWebhookPayloadEmailRead: ', $e->getMessage(), PHP_EOL; } ?> ParametersThis endpoint does not need any parameter.Return typeMailSlurpModelsWebhookEmailReadPayloadAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: /[Back to top] [Back to API list] [Back to Model list] [Back to ]getTestWebhookPayloadForWebhookMailSlurpModelsAbstractWebhookPayload getTestWebhookPayloadForWebhook($webhook_id)Get example payload for webhookExample<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: API_KEY $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer'); $apiInstance = new MailSlurpApiWebhookControllerApi( // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`. // This is optional, `GuzzleHttpClient` will be used as default. new GuzzleHttpClient(), $config ); $webhook_id = 'webhook_id_example'; // string | try { $result = $apiInstance->getTestWebhookPayloadForWebhook($webhook_id); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhookControllerApi->getTestWebhookPayloadForWebhook: ', $e->getMessage(), PHP_EOL; } ?> ParametersNameTypeDescriptionNoteswebhook_idstringReturn typeMailSlurpModelsAbstractWebhookPayloadAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: /[Back to top] [Back to API list] [Back to Model list] [Back to ]getTestWebhookPayloadNewAttachmentMailSlurpModelsWebhookNewAttachmentPayload getTestWebhookPayloadNewAttachment()Get webhook test payload for new attachment eventExample<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: API_KEY $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer'); $apiInstance = new MailSlurpApiWebhookControllerApi( // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`. // This is optional, `GuzzleHttpClient` will be used as default. new GuzzleHttpClient(), $config ); try { $result = $apiInstance->getTestWebhookPayloadNewAttachment(); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhookControllerApi->getTestWebhookPayloadNewAttachment: ', $e->getMessage(), PHP_EOL; } ?> ParametersThis endpoint does not need any parameter.Return typeMailSlurpModelsWebhookNewAttachmentPayloadAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: /[Back to top] [Back to API list] [Back to Model list] [Back to ]getTestWebhookPayloadNewContactMailSlurpModelsWebhookNewContactPayload getTestWebhookPayloadNewContact()Get webhook test payload for new contact eventExample<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: API_KEY $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer'); $apiInstance = new MailSlurpApiWebhookControllerApi( // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`. // This is optional, `GuzzleHttpClient` will be used as default. new GuzzleHttpClient(), $config ); try { $result = $apiInstance->getTestWebhookPayloadNewContact(); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhookControllerApi->getTestWebhookPayloadNewContact: ', $e->getMessage(), PHP_EOL; } ?> ParametersThis endpoint does not need any parameter.Return typeMailSlurpModelsWebhookNewContactPayloadAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: /[Back to top] [Back to API list] [Back to Model list] [Back to ]getTestWebhookPayloadNewEmailMailSlurpModelsWebhookNewEmailPayload getTestWebhookPayloadNewEmail()Get webhook test payload for new email eventExample<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: API_KEY $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer'); $apiInstance = new MailSlurpApiWebhookControllerApi( // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`. // This is optional, `GuzzleHttpClient` will be used as default. new GuzzleHttpClient(), $config ); try { $result = $apiInstance->getTestWebhookPayloadNewEmail(); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhookControllerApi->getTestWebhookPayloadNewEmail: ', $e->getMessage(), PHP_EOL; } ?> ParametersThis endpoint does not need any parameter.Return typeMailSlurpModelsWebhookNewEmailPayloadAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: /[Back to top] [Back to API list] [Back to Model list] [Back to ]getWebhookMailSlurpModelsWebhookDto getWebhook($webhook_id)Get a webhook for an InboxExample<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: API_KEY $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer'); $apiInstance = new MailSlurpApiWebhookControllerApi( // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`. // This is optional, `GuzzleHttpClient` will be used as default. new GuzzleHttpClient(), $config ); $webhook_id = 'webhook_id_example'; // string | try { $result = $apiInstance->getWebhook($webhook_id); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhookControllerApi->getWebhook: ', $e->getMessage(), PHP_EOL; } ?> ParametersNameTypeDescriptionNoteswebhook_idstringReturn typeMailSlurpModelsWebhookDtoAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: /[Back to top] [Back to API list] [Back to Model list] [Back to ]getWebhookResultMailSlurpModelsWebhookResultDto getWebhookResult($webhook_result_id)Get a webhook result for a webhookExample<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: API_KEY $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer'); $apiInstance = new MailSlurpApiWebhookControllerApi( // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`. // This is optional, `GuzzleHttpClient` will be used as default. new GuzzleHttpClient(), $config ); $webhook_result_id = 'webhook_result_id_example'; // string | Webhook Result ID try { $result = $apiInstance->getWebhookResult($webhook_result_id); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhookControllerApi->getWebhookResult: ', $e->getMessage(), PHP_EOL; } ?> ParametersNameTypeDescriptionNoteswebhook_result_idstringWebhook Result IDReturn typeMailSlurpModelsWebhookResultDtoAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: /[Back to top] [Back to API list] [Back to Model list] [Back to ]getWebhookResultsMailSlurpModelsPageWebhookResult getWebhookResults($webhook_id, $page, $size, $sort, $search_filter, $since, $before, $unseen_only)Get a webhook results for a webhookExample<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: API_KEY $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer'); $apiInstance = new MailSlurpApiWebhookControllerApi( // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`. // This is optional, `GuzzleHttpClient` will be used as default. new GuzzleHttpClient(), $config ); $webhook_id = 'webhook_id_example'; // string | ID of webhook to get results for $page = 0; // int | Optional page in list pagination $size = 20; // int | Optional page size in list pagination $sort = 'ASC'; // string | Optional createdAt sort direction ASC or DESC $search_filter = 'search_filter_example'; // string | Optional search filter $since = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | Filter by created at after the given timestamp $before = new DateTime("2013-10-20T19:20:30+01:00"); // DateTime | Filter by created at before the given timestamp $unseen_only = True; // bool | Filter for unseen exceptions only try { $result = $apiInstance->getWebhookResults($webhook_id, $page, $size, $sort, $search_filter, $since, $before, $unseen_only); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhookControllerApi->getWebhookResults: ', $e->getMessage(), PHP_EOL; } ?> ParametersNameTypeDescriptionNoteswebhook_idstringID of webhook to get results forpageintOptional page in list pagination[optional] [default to 0]sizeintOptional page size in list pagination[optional] [default to 20]sortstringOptional createdAt sort direction ASC or DESC[optional] [default to ‘ASC’]search_filterstringOptional search filter[optional]sinceDateTimeFilter by created at after the given timestamp[optional]beforeDateTimeFilter by created at before the given timestamp[optional]unseen_onlyboolFilter for unseen exceptions only[optional]Return typeMailSlurpModelsPageWebhookResultAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: /[Back to top] [Back to API list] [Back to Model list] [Back to ]getWebhookResultsUnseenErrorCountMailSlurpModelsUnseenErrorCountDto getWebhookResultsUnseenErrorCount($inbox_id)Get count of unseen webhook results with error statusExample<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: API_KEY $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer'); $apiInstance = new MailSlurpApiWebhookControllerApi( // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`. // This is optional, `GuzzleHttpClient` will be used as default. new GuzzleHttpClient(), $config ); $inbox_id = 'inbox_id_example'; // string | try { $result = $apiInstance->getWebhookResultsUnseenErrorCount($inbox_id); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhookControllerApi->getWebhookResultsUnseenErrorCount: ', $e->getMessage(), PHP_EOL; } ?> ParametersNameTypeDescriptionNotesinbox_idstringReturn typeMailSlurpModelsUnseenErrorCountDtoAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: /[Back to top] [Back to API list] [Back to Model list] [Back to ]getWebhooksMailSlurpModelsWebhookDto[] getWebhooks($inbox_id)Get all webhooks for an InboxExample<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: API_KEY $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer'); $apiInstance = new MailSlurpApiWebhookControllerApi( // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`. // This is optional, `GuzzleHttpClient` will be used as default. new GuzzleHttpClient(), $config ); $inbox_id = 'inbox_id_example'; // string | try { $result = $apiInstance->getWebhooks($inbox_id); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhookControllerApi->getWebhooks: ', $e->getMessage(), PHP_EOL; } ?> ParametersNameTypeDescriptionNotesinbox_idstringReturn type**MailSlurpModelsWebhookDto[]**AuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: /[Back to top] [Back to API list] [Back to Model list] [Back to ]redriveWebhookResultMailSlurpModelsWebhookRedriveResult redriveWebhookResult($webhook_result_id)Get a webhook result and try to resend the original webhook payloadAllows 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<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: API_KEY $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer'); $apiInstance = new MailSlurpApiWebhookControllerApi( // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`. // This is optional, `GuzzleHttpClient` will be used as default. new GuzzleHttpClient(), $config ); $webhook_result_id = 'webhook_result_id_example'; // string | Webhook Result ID try { $result = $apiInstance->redriveWebhookResult($webhook_result_id); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhookControllerApi->redriveWebhookResult: ', $e->getMessage(), PHP_EOL; } ?> ParametersNameTypeDescriptionNoteswebhook_result_idstringWebhook Result IDReturn typeMailSlurpModelsWebhookRedriveResultAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: /[Back to top] [Back to API list] [Back to Model list] [Back to ]sendTestDataMailSlurpModelsWebhookTestResult sendTestData($webhook_id)Send webhook test dataExample<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: API_KEY $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = MailSlurpConfiguration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer'); $apiInstance = new MailSlurpApiWebhookControllerApi( // If you want use custom http client, pass your client which implements `GuzzleHttpClientInterface`. // This is optional, `GuzzleHttpClient` will be used as default. new GuzzleHttpClient(), $config ); $webhook_id = 'webhook_id_example'; // string | try { $result = $apiInstance->sendTestData($webhook_id); print_r($result); } catch (Exception $e) { echo 'Exception when calling WebhookControllerApi->sendTestData: ', $e->getMessage(), PHP_EOL; } ?> ParametersNameTypeDescriptionNoteswebhook_idstringReturn typeMailSlurpModelsWebhookTestResultAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: /[Back to top] [Back to API list] [Back to Model list] [Back to ]