MailSlurpClient::WebhookControllerApiAll URIs are relative to https://api.mailslurp.comMethodHTTP requestDescriptioncreate_webhookPOST /inboxes/{inboxId}/webhooksAttach a WebHook URL to an inboxdelete_webhookDELETE /inboxes/{inboxId}/webhooks/{webhookId}Delete and disable a Webhook for an Inboxget_all_webhook_resultsGET /webhooks/resultsGet results for all webhooksget_all_webhooksGET /webhooks/paginatedList Webhooks Paginatedget_inbox_webhooks_paginatedGET /inboxes/{inboxId}/webhooks/paginatedGet paginated webhooks for an Inboxget_test_webhook_payloadGET /webhooks/testGet test webhook payload example. Response content depends on eventName passed. Uses EMAIL_RECEIVED as default.get_test_webhook_payload_email_openedGET /webhooks/test/email-opened-payloadGet webhook test payload for email opened eventget_test_webhook_payload_new_attachmentGET /webhooks/test/new-attachment-payloadGet webhook test payload for new attachment eventget_test_webhook_payload_new_contactGET /webhooks/test/new-contact-payloadGet webhook test payload for new contact eventget_test_webhook_payload_new_emailGET /webhooks/test/new-email-payloadGet webhook test payload for new email eventget_webhookGET /webhooks/{webhookId}Get a webhook for an Inboxget_webhook_resultGET /webhooks/results/{webhookResultId}Get a webhook result for a webhookget_webhook_resultsGET /webhooks/{webhookId}/resultsGet a webhook results for a webhookget_webhooksGET /inboxes/{inboxId}/webhooksGet all webhooks for an Inboxsend_test_dataPOST /webhooks/{webhookId}/testSend webhook test datacreate_webhookWebhookDto create_webhook(inbox_id, 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# load the gem require 'mailslurp_client' # setup authorization MailSlurpClient.configure do |config| # Configure API key authorization: API_KEY config.api_key['x-api-key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['x-api-key'] = 'Bearer' end api_instance = MailSlurpClient::WebhookControllerApi.new inbox_id = 'inbox_id_example' # String | inboxId webhook_options = MailSlurpClient::CreateWebhookOptions.new # CreateWebhookOptions | webhookOptions begin #Attach a WebHook URL to an inbox result = api_instance.create_webhook(inbox_id, webhook_options) p result rescue MailSlurpClient::ApiError => e puts "Exception when calling WebhookControllerApi->create_webhook: #{e}" end ParametersNameTypeDescriptionNotesinbox_idStringinboxIdwebhook_optionsCreateWebhookOptionswebhookOptionsReturn typeWebhookDtoAuthorizationAPI_KEYHTTP request headersContent-Type: application/jsonAccept: application/jsondelete_webhookdelete_webhook(inbox_id, webhook_id)Delete and disable a Webhook for an InboxExample# load the gem require 'mailslurp_client' # setup authorization MailSlurpClient.configure do |config| # Configure API key authorization: API_KEY config.api_key['x-api-key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['x-api-key'] = 'Bearer' end api_instance = MailSlurpClient::WebhookControllerApi.new inbox_id = 'inbox_id_example' # String | inboxId webhook_id = 'webhook_id_example' # String | webhookId begin #Delete and disable a Webhook for an Inbox api_instance.delete_webhook(inbox_id, webhook_id) rescue MailSlurpClient::ApiError => e puts "Exception when calling WebhookControllerApi->delete_webhook: #{e}" end ParametersNameTypeDescriptionNotesinbox_idStringinboxIdwebhook_idStringwebhookIdReturn typenil (empty response body)AuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: Not definedget_all_webhook_resultsPageWebhookResult get_all_webhook_results(opts)Get results for all webhooksExample# load the gem require 'mailslurp_client' # setup authorization MailSlurpClient.configure do |config| # Configure API key authorization: API_KEY config.api_key['x-api-key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['x-api-key'] = 'Bearer' end api_instance = MailSlurpClient::WebhookControllerApi.new opts = { page: 0, # Integer | Optional page in list pagination search_filter: 'search_filter_example', # String | Optional search filter size: 20, # Integer | Optional page size in list pagination sort: 'ASC' # String | Optional createdAt sort direction ASC or DESC } begin #Get results for all webhooks result = api_instance.get_all_webhook_results(opts) p result rescue MailSlurpClient::ApiError => e puts "Exception when calling WebhookControllerApi->get_all_webhook_results: #{e}" end ParametersNameTypeDescriptionNotespageIntegerOptional page in list pagination[optional] [default to 0]search_filterStringOptional search filter[optional]sizeIntegerOptional page size in list pagination[optional] [default to 20]sortStringOptional createdAt sort direction ASC or DESC[optional] [default to ‘ASC’]Return typePageWebhookResultAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/jsonget_all_webhooksPageWebhookProjection get_all_webhooks(opts)List Webhooks PaginatedList webhooks in paginated form. Allows for page , page size, and sort direction.Example# load the gem require 'mailslurp_client' # setup authorization MailSlurpClient.configure do |config| # Configure API key authorization: API_KEY config.api_key['x-api-key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['x-api-key'] = 'Bearer' end api_instance = MailSlurpClient::WebhookControllerApi.new opts = { page: 0, # Integer | Optional page in list pagination search_filter: 'search_filter_example', # String | Optional search filter size: 20, # Integer | Optional page size in list pagination sort: 'ASC' # String | Optional createdAt sort direction ASC or DESC } begin #List Webhooks Paginated result = api_instance.get_all_webhooks(opts) p result rescue MailSlurpClient::ApiError => e puts "Exception when calling WebhookControllerApi->get_all_webhooks: #{e}" end ParametersNameTypeDescriptionNotespageIntegerOptional page in list pagination[optional] [default to 0]search_filterStringOptional search filter[optional]sizeIntegerOptional page size in list pagination[optional] [default to 20]sortStringOptional createdAt sort direction ASC or DESC[optional] [default to ‘ASC’]Return typePageWebhookProjectionAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/jsonget_inbox_webhooks_paginatedPageWebhookProjection get_inbox_webhooks_paginated(inbox_id, opts)Get paginated webhooks for an InboxExample# load the gem require 'mailslurp_client' # setup authorization MailSlurpClient.configure do |config| # Configure API key authorization: API_KEY config.api_key['x-api-key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['x-api-key'] = 'Bearer' end api_instance = MailSlurpClient::WebhookControllerApi.new inbox_id = 'inbox_id_example' # String | inboxId opts = { page: 0, # Integer | Optional page in list pagination search_filter: 'search_filter_example', # String | Optional search filter size: 20, # Integer | Optional page size in list pagination sort: 'ASC' # String | Optional createdAt sort direction ASC or DESC } begin #Get paginated webhooks for an Inbox result = api_instance.get_inbox_webhooks_paginated(inbox_id, opts) p result rescue MailSlurpClient::ApiError => e puts "Exception when calling WebhookControllerApi->get_inbox_webhooks_paginated: #{e}" end ParametersNameTypeDescriptionNotesinbox_idStringinboxIdpageIntegerOptional page in list pagination[optional] [default to 0]search_filterStringOptional search filter[optional]sizeIntegerOptional page size in list pagination[optional] [default to 20]sortStringOptional createdAt sort direction ASC or DESC[optional] [default to ‘ASC’]Return typePageWebhookProjectionAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/jsonget_test_webhook_payloadAbstractWebhookPayload get_test_webhook_payload(opts)Get test webhook payload example. Response content depends on eventName passed. Uses EMAIL_RECEIVED as default.Example# load the gem require 'mailslurp_client' # setup authorization MailSlurpClient.configure do |config| # Configure API key authorization: API_KEY config.api_key['x-api-key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['x-api-key'] = 'Bearer' end api_instance = MailSlurpClient::WebhookControllerApi.new opts = { event_name: 'event_name_example' # String | eventName } begin #Get test webhook payload example. Response content depends on eventName passed. Uses `EMAIL_RECEIVED` as default. result = api_instance.get_test_webhook_payload(opts) p result rescue MailSlurpClient::ApiError => e puts "Exception when calling WebhookControllerApi->get_test_webhook_payload: #{e}" end ParametersNameTypeDescriptionNotesevent_nameStringeventName[optional]Return typeAbstractWebhookPayloadAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/jsonget_test_webhook_payload_email_openedWebhookEmailOpenedPayload get_test_webhook_payload_email_openedGet webhook test payload for email opened eventExample# load the gem require 'mailslurp_client' # setup authorization MailSlurpClient.configure do |config| # Configure API key authorization: API_KEY config.api_key['x-api-key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['x-api-key'] = 'Bearer' end api_instance = MailSlurpClient::WebhookControllerApi.new begin #Get webhook test payload for email opened event result = api_instance.get_test_webhook_payload_email_opened p result rescue MailSlurpClient::ApiError => e puts "Exception when calling WebhookControllerApi->get_test_webhook_payload_email_opened: #{e}" end ParametersThis endpoint does not need any parameter.Return typeWebhookEmailOpenedPayloadAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/jsonget_test_webhook_payload_new_attachmentWebhookNewAttachmentPayload get_test_webhook_payload_new_attachmentGet webhook test payload for new attachment eventExample# load the gem require 'mailslurp_client' # setup authorization MailSlurpClient.configure do |config| # Configure API key authorization: API_KEY config.api_key['x-api-key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['x-api-key'] = 'Bearer' end api_instance = MailSlurpClient::WebhookControllerApi.new begin #Get webhook test payload for new attachment event result = api_instance.get_test_webhook_payload_new_attachment p result rescue MailSlurpClient::ApiError => e puts "Exception when calling WebhookControllerApi->get_test_webhook_payload_new_attachment: #{e}" end ParametersThis endpoint does not need any parameter.Return typeWebhookNewAttachmentPayloadAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/jsonget_test_webhook_payload_new_contactWebhookNewContactPayload get_test_webhook_payload_new_contactGet webhook test payload for new contact eventExample# load the gem require 'mailslurp_client' # setup authorization MailSlurpClient.configure do |config| # Configure API key authorization: API_KEY config.api_key['x-api-key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['x-api-key'] = 'Bearer' end api_instance = MailSlurpClient::WebhookControllerApi.new begin #Get webhook test payload for new contact event result = api_instance.get_test_webhook_payload_new_contact p result rescue MailSlurpClient::ApiError => e puts "Exception when calling WebhookControllerApi->get_test_webhook_payload_new_contact: #{e}" end ParametersThis endpoint does not need any parameter.Return typeWebhookNewContactPayloadAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/jsonget_test_webhook_payload_new_emailWebhookNewEmailPayload get_test_webhook_payload_new_emailGet webhook test payload for new email eventExample# load the gem require 'mailslurp_client' # setup authorization MailSlurpClient.configure do |config| # Configure API key authorization: API_KEY config.api_key['x-api-key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['x-api-key'] = 'Bearer' end api_instance = MailSlurpClient::WebhookControllerApi.new begin #Get webhook test payload for new email event result = api_instance.get_test_webhook_payload_new_email p result rescue MailSlurpClient::ApiError => e puts "Exception when calling WebhookControllerApi->get_test_webhook_payload_new_email: #{e}" end ParametersThis endpoint does not need any parameter.Return typeWebhookNewEmailPayloadAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/jsonget_webhookWebhookDto get_webhook(webhook_id)Get a webhook for an InboxExample# load the gem require 'mailslurp_client' # setup authorization MailSlurpClient.configure do |config| # Configure API key authorization: API_KEY config.api_key['x-api-key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['x-api-key'] = 'Bearer' end api_instance = MailSlurpClient::WebhookControllerApi.new webhook_id = 'webhook_id_example' # String | webhookId begin #Get a webhook for an Inbox result = api_instance.get_webhook(webhook_id) p result rescue MailSlurpClient::ApiError => e puts "Exception when calling WebhookControllerApi->get_webhook: #{e}" end ParametersNameTypeDescriptionNoteswebhook_idStringwebhookIdReturn typeWebhookDtoAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/jsonget_webhook_resultWebhookResultEntity get_webhook_result(webhook_result_id)Get a webhook result for a webhookExample# load the gem require 'mailslurp_client' # setup authorization MailSlurpClient.configure do |config| # Configure API key authorization: API_KEY config.api_key['x-api-key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['x-api-key'] = 'Bearer' end api_instance = MailSlurpClient::WebhookControllerApi.new webhook_result_id = 'webhook_result_id_example' # String | Webhook Result ID begin #Get a webhook result for a webhook result = api_instance.get_webhook_result(webhook_result_id) p result rescue MailSlurpClient::ApiError => e puts "Exception when calling WebhookControllerApi->get_webhook_result: #{e}" end ParametersNameTypeDescriptionNoteswebhook_result_idStringWebhook Result IDReturn typeWebhookResultEntityAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/jsonget_webhook_resultsPageWebhookResult get_webhook_results(webhook_id, opts)Get a webhook results for a webhookExample# load the gem require 'mailslurp_client' # setup authorization MailSlurpClient.configure do |config| # Configure API key authorization: API_KEY config.api_key['x-api-key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['x-api-key'] = 'Bearer' end api_instance = MailSlurpClient::WebhookControllerApi.new webhook_id = 'webhook_id_example' # String | ID of webhook to get results for opts = { page: 0, # Integer | Optional page in list pagination search_filter: 'search_filter_example', # String | Optional search filter size: 20, # Integer | Optional page size in list pagination sort: 'ASC' # String | Optional createdAt sort direction ASC or DESC } begin #Get a webhook results for a webhook result = api_instance.get_webhook_results(webhook_id, opts) p result rescue MailSlurpClient::ApiError => e puts "Exception when calling WebhookControllerApi->get_webhook_results: #{e}" end ParametersNameTypeDescriptionNoteswebhook_idStringID of webhook to get results forpageIntegerOptional page in list pagination[optional] [default to 0]search_filterStringOptional search filter[optional]sizeIntegerOptional page size in list pagination[optional] [default to 20]sortStringOptional createdAt sort direction ASC or DESC[optional] [default to ‘ASC’]Return typePageWebhookResultAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/jsonget_webhooksArray get_webhooks(inbox_id)Get all webhooks for an InboxExample# load the gem require 'mailslurp_client' # setup authorization MailSlurpClient.configure do |config| # Configure API key authorization: API_KEY config.api_key['x-api-key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['x-api-key'] = 'Bearer' end api_instance = MailSlurpClient::WebhookControllerApi.new inbox_id = 'inbox_id_example' # String | inboxId begin #Get all webhooks for an Inbox result = api_instance.get_webhooks(inbox_id) p result rescue MailSlurpClient::ApiError => e puts "Exception when calling WebhookControllerApi->get_webhooks: #{e}" end ParametersNameTypeDescriptionNotesinbox_idStringinboxIdReturn typeArrayAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/jsonsend_test_dataWebhookTestResult send_test_data(webhook_id)Send webhook test dataExample# load the gem require 'mailslurp_client' # setup authorization MailSlurpClient.configure do |config| # Configure API key authorization: API_KEY config.api_key['x-api-key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['x-api-key'] = 'Bearer' end api_instance = MailSlurpClient::WebhookControllerApi.new webhook_id = 'webhook_id_example' # String | webhookId begin #Send webhook test data result = api_instance.send_test_data(webhook_id) p result rescue MailSlurpClient::ApiError => e puts "Exception when calling WebhookControllerApi->send_test_data: #{e}" end ParametersNameTypeDescriptionNoteswebhook_idStringwebhookIdReturn typeWebhookTestResultAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json