Create new custom event

[pasqualinibruno]

This PR adds a new a custom event that allows webhooks/integrations to be triggered manually. This is useful when we want to to set up a webhook/integration that shouldn't be triggered automatically by the system when one of the default entity events present in this bundle takes places such as CREATE, UPDATE, DELETE.

The following code shows how to make use of this functionality by creating a custom event that would trigger a webhook when an Oro payment transaction is completed.

1. Create a webhook custom event

services.yml

  MyBundle\Webhook\WebhookCustomEventPaymentTransactionComplete:
    tags:
      - { name: aligent_async_events.custom_events }

WebhookCustomEventPaymentTransactionComplete class

class WebhookCustomEventPaymentTransactionComplete implements WebhookCustomEventInterface
{
    private const PAYMENT_TRANSACTION_COMPLETE = 'payment_complete';
    private const TRANSLATION_EVENT_NAME = 'mybundle.async.transport.form.custom_event.payment_transaction_complete';

    /**
     * @inheritDoc
     */
    public static function getTranslationName(): string
    {
        return self::TRANSLATION_EVENT_NAME;
    }

    /**
     * @inheritDoc
     */
    public static function getKey(): string
    {
        return self::PAYMENT_TRANSACTION_COMPLETE;
    }
}

messages.en.yml

mybundle.async.transport.form.custom_event.payment_transaction_complete: Custom - Payment Transaction Complete

2. Once the above has been implemented, you should see your new custom event as a option in the event dropdown

3. Listen to payment transactions

  MyBundle\EventListener\PaymentTransactionListener:
    arguments:
      - '@oro_message_queue.client.message_producer'
      - '@Aligent\AsyncEventsBundle\Provider\WebhookConfigProvider'
    tags:
      - { name: kernel.event_listener, event: oro_payment.event.transaction_complete, method: onTransactionComplete, priority: -256 }

4. Trigger webhook custom event

        $webhookEntityConfig = $this->webhookConfigProvider->getNotificationChannels(
            Order::class,
            WebhookCustomEventPaymentTransactionComplete::getKey()
        );

        foreach ($webhookEntityConfig as $channelId) {
            $this->producer->send(
                Topics::WEBHOOK_ENTITY_CUSTOM,
                [
                    'class' => Order::class,
                    'id' => ['id' => $order->getId()],
                    'channelId' => $channelId
                ]
            );
        }