Skip to content

Commit

Permalink
some tweaks for the Webhook docs
Browse files Browse the repository at this point in the history
  • Loading branch information
xabbuh committed Dec 22, 2023
1 parent f43dff0 commit 02714bb
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion notifier.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 </webhook>` for more
details.

Expand Down
14 changes: 7 additions & 7 deletions webhook.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 <mailer_3rd_party_transport>`.

The Webhook component routing needs to be defined:
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 02714bb

Please sign in to comment.