All URIs are relative to https://api.mailslurp.com
| Method | HTTP request | Description |
|---|---|---|
| CreateWebhook | Post /inboxes/{inboxId}/webhooks | Attach a WebHook URL to an inbox |
| DeleteWebhook | Delete /inboxes/{inboxId}/webhooks/{webhookId} | Delete and disable a Webhook for an Inbox |
| GetAllWebhooks | Get /webhooks/paginated | List Webhooks Paginated |
| GetWebhook | Get /webhooks/{webhookId} | Get a webhook for an Inbox |
| GetWebhooks | Get /inboxes/{inboxId}/webhooks | Get all Webhooks for an Inbox |
| SendTestData | Post /webhooks/{webhookId}/test | Send webhook test data |
WebhookDto CreateWebhook(ctx, inboxId, webhookOptions)
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.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| inboxId | string | inboxId | |
| webhookOptions | CreateWebhookOptions | webhookOptions |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteWebhook(ctx, inboxId, webhookId)
Delete and disable a Webhook for an Inbox
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| inboxId | string | inboxId | |
| webhookId | string | webhookId |
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
PageWebhookProjection GetAllWebhooks(ctx, optional)
List Webhooks Paginated
List webhooks in paginated form. Allows for page index, page size, and sort direction.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetAllWebhooksOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetAllWebhooksOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| page | optional.Int32 | Optional page index in inbox list pagination | [default to 0] |
| size | optional.Int32 | Optional page size in inbox list pagination | [default to 20] |
| sort | optional.String | Optional createdAt sort direction ASC or DESC | [default to ASC] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
WebhookDto GetWebhook(ctx, webhookId)
Get a webhook for an Inbox
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| webhookId | string | webhookId |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]WebhookDto GetWebhooks(ctx, inboxId)
Get all Webhooks for an Inbox
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| inboxId | string | inboxId |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
WebhookTestResult SendTestData(ctx, webhookId)
Send webhook test data
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| webhookId | string | webhookId |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]