minor #19421 Tweak docs for Webhooks (fabpot)

This PR was merged into the 6.3 branch. Discussion ---------- Tweak docs for Webhooks Thank you so much `@TimoBakx` for having bootstrapped the webhook docs. This PR hopefully contains some improvements. _I will be able to merge this PR up as it will probably generate some conflicts_ Commits ------- 534babd Tweak docs for Webhooks

Author: OskarStark

webhook.rst

@@ -19,17 +19,26 @@ Installation
 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.
+When using a third-party mailer provider, you can use the Webhook component to
+receive webhook calls from this provider.
 
-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.
+Currently, the following third-party mailer providers support webhooks:
 
-Install the third-party mailer as described in the documentation of the
-:ref:`Mailer component <mailer_3rd_party_transport>`.
+=============== ==========================================
+Mailer service Parser service name
+=============== ==========================================
+Mailgun ``mailer.webhook.request_parser.mailgun``
+Postmark ``mailer.webhook.request_parser.postmark``
+=============== ==========================================
+
+.. note::
+
+ Install the third-party mailer provider you want to use as described in the
+ documentation of the :ref:`Mailer component <mailer_3rd_party_transport>`.
+ Mailgun is used as the provider in this document as an example.
 
-The Webhook component routing needs to be defined:
+To connect the provider to your application, you need to configure the Webhook
+component routing:
 
 .. configuration-block::
 
@@ -77,27 +86,27 @@ The Webhook component routing needs to be defined:
  ;
  };
 
-Currently, the following third-party mailer services support webhooks:
+In this example, we are using ``mailer_mailgun`` as the webhook routing name.
+The routing name must be unique as this is what connects the provider with your
+webhook consumer code.
 
-=============== ==========================================
-Mailer service Parser service name
-=============== ==========================================
-Mailgun ``mailer.webhook.request_parser.mailgun``
-Postmark ``mailer.webhook.request_parser.postmark``
-=============== ==========================================
-
-Set up the webhook in the third-party mailer. For Mailgun, you can do this
-in the control panel. As URL, make sure to use the ``/webhook/mailer_mailgun``
-path behind the domain you're using.
+The webhook routing name is part of the URL you need to configure at the
+third-party mailer provider. The URL is the concatenation of your domain name
+and the routing name you chose in the configuration (like
+``https://example.com/webhook/mailer_mailgun``.
 
-Mailgun will provide a secret for the webhook. Add this secret to your ``.env``
-file:
+For Mailgun, you will get a secret for the webhook. Store this secret as
+MAILER_MAILGUN_SECRET (in the :doc:`secrets management system
+</configuration/secrets>` or in a ``.env`` file).
 
-.. code-block:: env
+When done, add a :class:`Symfony\\Component\\RemoteEvent\\RemoteEvent` consumer
+to react to incoming webhooks (the webhook routing name is what connects your
+class to the provider).
 
- MAILER_MAILGUN_SECRET=your_secret
-
-With this done, you can now add a RemoteEvent consumer to react to the webhooks::
+For mailer webhooks, react to the
+:class:`Symfony\\Component\\RemoteEvent\\Event\\Mailer\\MailerDeliveryEvent` or
+:class:`Symfony\\Component\\RemoteEvent\\Event\\Mailer\\MailerEngagementEvent`
+events::
 
  use Symfony\Component\RemoteEvent\Attribute\AsRemoteEventConsumer;
  use Symfony\Component\RemoteEvent\Consumer\ConsumerInterface;
@@ -145,12 +154,8 @@ SMS service Parser service name
 Twilio ``notifier.webhook.request_parser.twilio``
 ============ ==========================================
 
-.. versionadded:: 6.3
-
- The support for Twilio was introduced in Symfony 6.3.
-
-For SMS transports, an additional ``SmsEvent`` is available in the RemoteEvent
-consumer::
+For SMS webhooks, react to the
+:class:`Symfony\\Component\\RemoteEvent\\Event\\Sms\\SmsEvent` event::
 
  use Symfony\Component\RemoteEvent\Attribute\AsRemoteEventConsumer;
  use Symfony\Component\RemoteEvent\Consumer\ConsumerInterface;
@@ -165,13 +170,13 @@ consumer::
  if ($event instanceof SmsEvent) {
  $this->handleSmsEvent($event);
  } else {
- // This is not an sms event
+ // This is not an SMS event
  return;
  }
  }
 
  private function handleSmsEvent(SmsEvent $event): void
  {
- // Handle the sms event
+ // Handle the SMS event
  }
  }