MailSlurpAPI.Api.WebhookController (mailslurp v14.0.3)
API calls for all endpoints tagged WebhookController
.
Link to this section Summary
Functions
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.
Delete all webhooks
Delete and disable a Webhook for an Inbox
Get results for all webhooks
List Webhooks Paginated List webhooks in paginated form. Allows for page index, page size, and sort direction.
Get paginated webhooks for an Inbox
Get JSON Schema definition for webhook payload
Get test webhook payload example. Response content depends on eventName passed. Uses EMAIL_RECEIVED
as default.
Get webhook test payload for email opened event
Get webhook test payload for email opened event
Get example payload for webhook
Get webhook test payload for new attachment event
Get webhook test payload for new contact event
Get webhook test payload for new email event
Get a webhook for an Inbox
Get a webhook result for a webhook
Get a webhook results for a webhook
Get count of unseen webhook results with error status
Get all webhooks for an Inbox
Get a webhook result and try to resend the original webhook payload Allows 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.
Send webhook test data
Link to this section Functions
create_webhook(connection, inbox_id, webhook_options, opts \\ [])
Specs
create_webhook( Tesla.Env.client(), String.t(), MailSlurpAPI.Model.CreateWebhookOptions.t(), keyword() ) :: {:ok, MailSlurpAPI.Model.WebhookDto.t()} | {:error, Tesla.Env.t()}
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
- connection (MailSlurpAPI.Connection): Connection to server
- inbox_id (String.t): inboxId
- webhook_options (CreateWebhookOptions): webhookOptions
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
delete_all_webhooks(connection, opts \\ [])
Specs
delete_all_webhooks(Tesla.Env.client(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Delete all webhooks
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
delete_webhook(connection, inbox_id, webhook_id, opts \\ [])
Specs
delete_webhook(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Delete and disable a Webhook for an Inbox
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- inbox_id (String.t): inboxId
- webhook_id (String.t): webhookId
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
get_all_webhook_results(connection, opts \\ [])
Specs
get_all_webhook_results(Tesla.Env.client(), keyword()) :: {:ok, MailSlurpAPI.Model.PageWebhookResult.t()} | {:error, Tesla.Env.t()}
Get results for all webhooks
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :before (DateTime.t): Filter by created at before the given timestamp
- :page (integer()): Optional page index in list pagination
- :search_filter (String.t): Optional search filter
- :since (DateTime.t): Filter by created at after the given timestamp
- :size (integer()): Optional page size in list pagination
- :sort (String.t): Optional createdAt sort direction ASC or DESC
- :unseen_only (boolean()): Filter for unseen exceptions only
Returns
} on success {:error, info} on failure
get_all_webhooks(connection, opts \\ [])
Specs
get_all_webhooks(Tesla.Env.client(), keyword()) :: {:ok, MailSlurpAPI.Model.PageWebhookProjection.t()} | {:error, Tesla.Env.t()}
List Webhooks Paginated List webhooks in paginated form. Allows for page index, page size, and sort direction.
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :before (DateTime.t): Filter by created at before the given timestamp
- :page (integer()): Optional page index in list pagination
- :search_filter (String.t): Optional search filter
- :since (DateTime.t): Filter by created at after the given timestamp
- :size (integer()): Optional page size for paginated result list.
- :sort (String.t): Optional createdAt sort direction ASC or DESC
Returns
} on success {:error, info} on failure
get_inbox_webhooks_paginated(connection, inbox_id, opts \\ [])
Specs
get_inbox_webhooks_paginated(Tesla.Env.client(), String.t(), keyword()) :: {:ok, MailSlurpAPI.Model.PageWebhookProjection.t()} | {:error, Tesla.Env.t()}
Get paginated webhooks for an Inbox
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- inbox_id (String.t): inboxId
- opts (KeywordList): [optional] Optional parameters
- :before (DateTime.t): Filter by created at before the given timestamp
- :page (integer()): Optional page index in list pagination
- :search_filter (String.t): Optional search filter
- :since (DateTime.t): Filter by created at after the given timestamp
- :size (integer()): Optional page size in list pagination
- :sort (String.t): Optional createdAt sort direction ASC or DESC
Returns
} on success {:error, info} on failure
get_json_schema_for_webhook_payload(connection, webhook_id, opts \\ [])
Specs
get_json_schema_for_webhook_payload(Tesla.Env.client(), String.t(), keyword()) :: {:ok, MailSlurpAPI.Model.JsonSchemaDto.t()} | {:error, Tesla.Env.t()}
Get JSON Schema definition for webhook payload
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- webhook_id (String.t): webhookId
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
get_test_webhook_payload(connection, opts \\ [])
Specs
get_test_webhook_payload(Tesla.Env.client(), keyword()) :: {:ok, MailSlurpAPI.Model.AbstractWebhookPayload.t()} | {:error, Tesla.Env.t()}
Get test webhook payload example. Response content depends on eventName passed. Uses EMAIL_RECEIVED
as default.
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
} on success {:error, info} on failure
get_test_webhook_payload_email_opened(connection, opts \\ [])
Specs
get_test_webhook_payload_email_opened(Tesla.Env.client(), keyword()) :: {:ok, MailSlurpAPI.Model.WebhookEmailOpenedPayload.t()} | {:error, Tesla.Env.t()}
Get webhook test payload for email opened event
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
get_test_webhook_payload_email_read(connection, opts \\ [])
Specs
get_test_webhook_payload_email_read(Tesla.Env.client(), keyword()) :: {:ok, MailSlurpAPI.Model.WebhookEmailReadPayload.t()} | {:error, Tesla.Env.t()}
Get webhook test payload for email opened event
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
get_test_webhook_payload_for_webhook(connection, webhook_id, opts \\ [])
Specs
get_test_webhook_payload_for_webhook(Tesla.Env.client(), String.t(), keyword()) :: {:ok, MailSlurpAPI.Model.AbstractWebhookPayload.t()} | {:error, Tesla.Env.t()}
Get example payload for webhook
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- webhook_id (String.t): webhookId
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
get_test_webhook_payload_new_attachment(connection, opts \\ [])
Specs
get_test_webhook_payload_new_attachment(Tesla.Env.client(), keyword()) :: {:ok, MailSlurpAPI.Model.WebhookNewAttachmentPayload.t()} | {:error, Tesla.Env.t()}
Get webhook test payload for new attachment event
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
get_test_webhook_payload_new_contact(connection, opts \\ [])
Specs
get_test_webhook_payload_new_contact(Tesla.Env.client(), keyword()) :: {:ok, MailSlurpAPI.Model.WebhookNewContactPayload.t()} | {:error, Tesla.Env.t()}
Get webhook test payload for new contact event
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
get_test_webhook_payload_new_email(connection, opts \\ [])
Specs
get_test_webhook_payload_new_email(Tesla.Env.client(), keyword()) :: {:ok, MailSlurpAPI.Model.WebhookNewEmailPayload.t()} | {:error, Tesla.Env.t()}
Get webhook test payload for new email event
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
get_webhook(connection, webhook_id, opts \\ [])
Specs
get_webhook(Tesla.Env.client(), String.t(), keyword()) :: {:ok, MailSlurpAPI.Model.WebhookDto.t()} | {:error, Tesla.Env.t()}
Get a webhook for an Inbox
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- webhook_id (String.t): webhookId
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
get_webhook_result(connection, webhook_result_id, opts \\ [])
Specs
get_webhook_result(Tesla.Env.client(), String.t(), keyword()) :: {:ok, MailSlurpAPI.Model.WebhookResultDto.t()} | {:error, Tesla.Env.t()}
Get a webhook result for a webhook
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- webhook_result_id (String.t): Webhook Result ID
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
get_webhook_results(connection, webhook_id, opts \\ [])
Specs
get_webhook_results(Tesla.Env.client(), String.t(), keyword()) :: {:ok, MailSlurpAPI.Model.PageWebhookResult.t()} | {:error, Tesla.Env.t()}
Get a webhook results for a webhook
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- webhook_id (String.t): ID of webhook to get results for
- opts (KeywordList): [optional] Optional parameters
- :before (DateTime.t): Filter by created at before the given timestamp
- :page (integer()): Optional page index in list pagination
- :search_filter (String.t): Optional search filter
- :since (DateTime.t): Filter by created at after the given timestamp
- :size (integer()): Optional page size in list pagination
- :sort (String.t): Optional createdAt sort direction ASC or DESC
- :unseen_only (boolean()): Filter for unseen exceptions only
Returns
} on success {:error, info} on failure
get_webhook_results_unseen_error_count(connection, inbox_id, opts \\ [])
Specs
get_webhook_results_unseen_error_count( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, MailSlurpAPI.Model.UnseenErrorCountDto.t()} | {:error, Tesla.Env.t()}
Get count of unseen webhook results with error status
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- inbox_id (String.t): inboxId
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
get_webhooks(connection, inbox_id, opts \\ [])
Specs
get_webhooks(Tesla.Env.client(), String.t(), keyword()) :: {:ok, [MailSlurpAPI.Model.WebhookDto.t()]} | {:error, Tesla.Env.t()}
Get all webhooks for an Inbox
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- inbox_id (String.t): inboxId
- opts (KeywordList): [optional] Optional parameters
Returns
, ...]} on success {:error, info} on failure
redrive_webhook_result(connection, webhook_result_id, opts \\ [])
Specs
redrive_webhook_result(Tesla.Env.client(), String.t(), keyword()) :: {:ok, MailSlurpAPI.Model.WebhookRedriveResult.t()} | {:error, Tesla.Env.t()}
Get a webhook result and try to resend the original webhook payload Allows 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.
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- webhook_result_id (String.t): Webhook Result ID
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
send_test_data(connection, webhook_id, opts \\ [])
Specs
send_test_data(Tesla.Env.client(), String.t(), keyword()) :: {:ok, MailSlurpAPI.Model.WebhookTestResult.t()} | {:error, Tesla.Env.t()}
Send webhook test data
Parameters
- connection (MailSlurpAPI.Connection): Connection to server
- webhook_id (String.t): webhookId
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure