From 2fc4c2fe7957f27e7aecd6fb0c38b7b075fb8455 Mon Sep 17 00:00:00 2001 From: Christian Flothmann Date: Fri, 22 Dec 2023 14:46:59 +0100 Subject: [PATCH] some tweaks for the Webhook docs --- mailer.rst | 2 +- notifier.rst | 2 +- webhook.rst | 14 +++++++------- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/mailer.rst b/mailer.rst index 8354400ac5c..85cae8368c4 100644 --- a/mailer.rst +++ b/mailer.rst @@ -281,7 +281,7 @@ party provider: .. tip:: - Some third party mailers, when using the API, support status callback + Some third party mailers, when using the API, support status callbacks via webhooks. See the :doc:`Webhook documentation ` for more details. diff --git a/notifier.rst b/notifier.rst index 29af133278a..d964272bec1 100644 --- a/notifier.rst +++ b/notifier.rst @@ -118,7 +118,7 @@ Service Package DSN .. tip:: - Some third party transports, when using the API, support status callback + Some third party transports, when using the API, support status callbacks via webhooks. See the :doc:`Webhook documentation ` for more details. diff --git a/webhook.rst b/webhook.rst index b7457bb2e08..ded720ff75b 100644 --- a/webhook.rst +++ b/webhook.rst @@ -3,7 +3,7 @@ Webhook .. versionadded:: 6.3 - The Webhook component was introduced in Symfony 6.3 + The Webhook component was introduced in Symfony 6.3. The Webhook component is used to respond to remote webhooks to trigger actions in your application. This document focuses on using webhooks to listen to remote @@ -16,17 +16,17 @@ Installation $ composer require symfony/webhook -Usage in combination with the Mailer component +Usage in Combination with the Mailer Component ---------------------------------------------- When using a third-party mailer, you can use the Webhook component to receive webhook calls from the third-party mailer. -In this example Mailgun is used with ``'mailer_mailgun'`` as webhook type. -Any type name can be used as long as it's unique. Make sure to use it in the +In this example Mailgun is used with ``'mailer_mailgun'`` as the webhook type. +Any type name can be used as long as it is unique. Make sure to use it in the routing configuration, the webhook URL and the RemoteEvent consumer. -Install the third party mailer as described in the documentation of the +Install the third-party mailer as described in the documentation of the :ref:`Mailer component `. The Webhook component routing needs to be defined: @@ -131,13 +131,13 @@ With this done, you can now add a RemoteEvent consumer to react to the webhooks: } } -Usage in combination with the Notifier component +Usage in Combination with the Notifier Component ------------------------------------------------ The usage of the Webhook component when using a third-party transport in the Notifier is very similar to the usage with the Mailer. -Currently, the following third-party sms transports support webhooks: +Currently, the following third-party SMS transports support webhooks: ============ ========================================== SMS service Parser service name