# \WebhookControllerApi

All URIs are relative to https://api.mailslurp.com

Method HTTP request Description
create_webhook Post /inboxes/{inboxId}/webhooks Attach a WebHook URL to an inbox
delete_webhook Delete /inboxes/{inboxId}/webhooks/{webhookId} Delete and disable a Webhook for an Inbox
get_all_webhooks Get /webhooks/paginated List Webhooks Paginated
get_webhook Get /webhooks/{webhookId} Get a webhook for an Inbox
get_webhooks Get /inboxes/{inboxId}/webhooks Get all Webhooks for an Inbox
send_test_data Post /webhooks/{webhookId}/test Send webhook test data

# create_webhook

crate::models::WebhookDto create_webhook(inbox_id, webhook_options) 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.

# Parameters

Name Type Description Required Notes
inbox_id String inboxId [required]
webhook_options CreateWebhookOptions webhookOptions [required]

# Return type

crate::models::WebhookDto

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# delete_webhook

delete_webhook(inbox_id, webhook_id) Delete and disable a Webhook for an Inbox

# Parameters

Name Type Description Required Notes
inbox_id String inboxId [required]
webhook_id String webhookId [required]

# Return type

(empty response body)

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# get_all_webhooks

crate::models::PageWebhookProjection get_all_webhooks(page, size, sort) List Webhooks Paginated

List webhooks in paginated form. Allows for page index, page size, and sort direction.

# Parameters

Name Type Description Required Notes
page Option<i32> Optional page index in inbox list pagination [default to 0]
size Option<i32> Optional page size in inbox list pagination [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]

# Return type

crate::models::PageWebhookProjection

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# get_webhook

crate::models::WebhookDto get_webhook(webhook_id) Get a webhook for an Inbox

# Parameters

Name Type Description Required Notes
webhook_id String webhookId [required]

# Return type

crate::models::WebhookDto

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# get_webhooks

Veccrate::models::WebhookDto get_webhooks(inbox_id) Get all Webhooks for an Inbox

# Parameters

Name Type Description Required Notes
inbox_id String inboxId [required]

# Return type

Veccrate::models::WebhookDto

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# send_test_data

crate::models::WebhookTestResult send_test_data(webhook_id) Send webhook test data

# Parameters

Name Type Description Required Notes
webhook_id String webhookId [required]

# Return type

crate::models::WebhookTestResult

# Authorization

API_KEY

# HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]