MailSlurpWebhookControllerApiAll URIs are relative to https://api.mailslurp.comMethodHTTP requestDescriptionCreateWebhookPost /inboxes/{inboxId}/webhooksAttach a WebHook URL to an inboxDeleteWebhookDelete /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 InboxGetTestWebhookPayloadGet /webhooks/testGet test webhook payload example. Response content depends on eventName passed. Uses EMAIL_RECEIVED as default.GetTestWebhookPayloadEmailOpenedGet /webhooks/test/email-opened-payloadGet webhook test payload for email opened eventGetTestWebhookPayloadNewAttachmentGet /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 webhookGetWebhooksGet /inboxes/{inboxId}/webhooksGet all webhooks for an InboxSendTestDataPost /webhooks/{webhookId}/testSend webhook test dataCreateWebhookWebhookDto CreateWebhook(ctx, inboxId, webhookOptions)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.Required ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.inboxIdstringinboxIdwebhookOptionsCreateWebhookOptionswebhookOptionsReturn typeWebhookDtoAuthorizationAPI_KEYHTTP request headersContent-Type: application/jsonAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]DeleteWebhookDeleteWebhook(ctx, inboxId, webhookId)Delete and disable a Webhook for an InboxRequired ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.inboxIdstringinboxIdwebhookIdstringwebhookIdReturn type(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 ]GetAllWebhookResultsPageWebhookResult GetAllWebhookResults(ctx, optional)Get results for all webhooksRequired ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.optional*GetAllWebhookResultsOptsoptional parametersnil if no parametersOptional ParametersOptional parameters are passed through a pointer to a GetAllWebhookResultsOpts structNameTypeDescriptionNotespageoptional.Int32Optional page in list pagination[default to 0]searchFilteroptional.StringOptional search filtersizeoptional.Int32Optional page size in list pagination[default to 20]sortoptional.StringOptional createdAt sort direction ASC or DESC[default to ASC]Return typePageWebhookResultAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]GetAllWebhooksPageWebhookProjection GetAllWebhooks(ctx, optional)List Webhooks PaginatedList webhooks in paginated form. Allows for page , page size, and sort direction.Required ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.optional*GetAllWebhooksOptsoptional parametersnil if no parametersOptional ParametersOptional parameters are passed through a pointer to a GetAllWebhooksOpts structNameTypeDescriptionNotespageoptional.Int32Optional page in list pagination[default to 0]searchFilteroptional.StringOptional search filtersizeoptional.Int32Optional page size in list pagination[default to 20]sortoptional.StringOptional createdAt sort direction ASC or DESC[default to ASC]Return typePageWebhookProjectionAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]GetInboxWebhooksPaginatedPageWebhookProjection GetInboxWebhooksPaginated(ctx, inboxId, optional)Get paginated webhooks for an InboxRequired ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.inboxIdstringinboxIdoptional*GetInboxWebhooksPaginatedOptsoptional parametersnil if no parametersOptional ParametersOptional parameters are passed through a pointer to a GetInboxWebhooksPaginatedOpts structNameTypeDescriptionNotespage | optional.Int32| Optional page in list pagination | [default to 0] searchFilter | optional.String| Optional search filter | size | optional.Int32| Optional page size in list pagination | [default to 20] sort | optional.String| Optional createdAt sort direction ASC or DESC | [default to ASC]Return typePageWebhookProjectionAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]GetTestWebhookPayloadAbstractWebhookPayload GetTestWebhookPayload(ctx, optional)Get test webhook payload example. Response content depends on eventName passed. Uses EMAIL_RECEIVED as default.Required ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.optional*GetTestWebhookPayloadOptsoptional parametersnil if no parametersOptional ParametersOptional parameters are passed through a pointer to a GetTestWebhookPayloadOpts structNameTypeDescriptionNoteseventNameoptional.StringeventNameReturn typeAbstractWebhookPayloadAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]GetTestWebhookPayloadEmailOpenedWebhookEmailOpenedPayload GetTestWebhookPayloadEmailOpened(ctx, )Get webhook test payload for email opened eventRequired ParametersThis endpoint does not need any parameter.Return typeWebhookEmailOpenedPayloadAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]GetTestWebhookPayloadNewAttachmentWebhookNewAttachmentPayload GetTestWebhookPayloadNewAttachment(ctx, )Get webhook test payload for new attachment eventRequired ParametersThis endpoint does not need any parameter.Return typeWebhookNewAttachmentPayloadAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]GetTestWebhookPayloadNewContactWebhookNewContactPayload GetTestWebhookPayloadNewContact(ctx, )Get webhook test payload for new contact eventRequired ParametersThis endpoint does not need any parameter.Return typeWebhookNewContactPayloadAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]GetTestWebhookPayloadNewEmailWebhookNewEmailPayload GetTestWebhookPayloadNewEmail(ctx, )Get webhook test payload for new email eventRequired ParametersThis endpoint does not need any parameter.Return typeWebhookNewEmailPayloadAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]GetWebhookWebhookDto GetWebhook(ctx, webhookId)Get a webhook for an InboxRequired ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.webhookIdstringwebhookIdReturn typeWebhookDtoAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]GetWebhookResultWebhookResultEntity GetWebhookResult(ctx, webhookResultId)Get a webhook result for a webhookRequired ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.webhookResultIdstringWebhook Result IDReturn typeWebhookResultEntityAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]GetWebhookResultsPageWebhookResult GetWebhookResults(ctx, webhookId, optional)Get a webhook results for a webhookRequired ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.webhookIdstringID of webhook to get results foroptional*GetWebhookResultsOptsoptional parametersnil if no parametersOptional ParametersOptional parameters are passed through a pointer to a GetWebhookResultsOpts structNameTypeDescriptionNotespage | optional.Int32| Optional page in list pagination | [default to 0] searchFilter | optional.String| Optional search filter | size | optional.Int32| Optional page size in list pagination | [default to 20] sort | optional.String| Optional createdAt sort direction ASC or DESC | [default to ASC]Return typePageWebhookResultAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]GetWebhooks[]WebhookDto GetWebhooks(ctx, inboxId)Get all webhooks for an InboxRequired ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.inboxIdstringinboxIdReturn type**[]WebhookDto**AuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]SendTestDataWebhookTestResult SendTestData(ctx, webhookId)Send webhook test dataRequired ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.webhookIdstringwebhookIdReturn typeWebhookTestResultAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]