Webhook

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

// src/Webhook/AcmeWebhookRequestParser.php
namespace App\Webhook;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestMatcher\ChainRequestMatcher;
use Symfony\Component\HttpFoundation\RequestMatcher\IsJsonRequestMatcher;
use Symfony\Component\HttpFoundation\RequestMatcher\MethodRequestMatcher;
use Symfony\Component\HttpFoundation\RequestMatcher\RequestMatcherInterface;
use Symfony\Component\RemoteEvent\RemoteEvent;
use Symfony\Component\Webhook\Client\AbstractRequestParser;

final class AcmeWebhookRequestParser extends AbstractRequestParser
{
    protected function getRequestMatcher(): RequestMatcherInterface
    {
        return new ChainRequestMatcher([
            new IsJsonRequestMatcher(),
            new MethodRequestMatcher('POST'),
        ]);
    }

    protected function doParse(
        Request $request,
        #[\SensitiveParameter] string $secret
    ): ?RemoteEvent {
        $payload = $request->toArray();

        return new RemoteEvent(
            $payload['event_type'],
            $payload['event_id'],
            $payload,
        );
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

// tests/Webhook/AcmeWebhookRequestParserTest.php
namespace App\Tests\Webhook;

use App\Webhook\AcmeWebhookRequestParser;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Webhook\Client\Tests\AbstractRequestParserTest;

class AcmeWebhookRequestParserTest extends AbstractRequestParserTest
{
    protected function createRequestParser(): AcmeWebhookRequestParser
    {
        return new AcmeWebhookRequestParser();
    }

    // default createRequest() builds a POST request with Content-Type: application/json
    // override it to add provider-specific headers (e.g., webhook signatures) or change the method
    protected function createRequest(string $payload): Request
    {
        return Request::create('/', 'POST', [], [], [], // the routing is not actually tested
            [
                'CONTENT_TYPE' => 'application/json', // add headers as needed
            ],
            $payload
        );
    }
}

1
2
3
4
5
6
7
8
9
10
11
12

// tests/Webhook/Fixtures/resource.created.php
use Symfony\Component\RemoteEvent\RemoteEvent;

return new RemoteEvent(
    name: 'resource.created',
    id: '550e8400-e29b-41d4-a716-446655440000',
    payload: [
        'event_type' => 'resource.created',
        'event_id' => '550e8400-e29b-41d4-a716-446655440000',
        'email' => 'user@example.com',
    ]
);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

// src/RemoteEvent/AcmeWebhookPayloadConverter.php
namespace App\RemoteEvent;

use Symfony\Component\RemoteEvent\PayloadConverterInterface;
use Symfony\Component\RemoteEvent\RemoteEvent;

final class AcmeWebhookPayloadConverter implements PayloadConverterInterface
{
    public function convert(array $payload): RemoteEvent
    {
        // map external event names to your domain events
        $eventName = match ($payload['event_type']) {
            'resource.created' => 'acme.resource_created',
            'resource.updated' => 'acme.resource_updated',
            'resource.deleted' => 'acme.resource_deleted',
            default => 'acme.unknown_event',
        };

        return new RemoteEvent($eventName, $payload['event_id'], $payload);
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

// src/Webhook/AcmeWebhookRequestParser.php
namespace App\Webhook;

use App\RemoteEvent\AcmeWebhookPayloadConverter;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\RemoteEvent\PayloadConverterInterface;
use Symfony\Component\RemoteEvent\RemoteEvent;
use Symfony\Component\Webhook\Client\AbstractRequestParser;
use Symfony\Component\Webhook\Exception\RejectWebhookException;
use Symfony\DependencyInjection\Attribute\Autowire;

final class AcmeWebhookRequestParser extends AbstractRequestParser
{
    public function __construct(
        #[Autowire(service: AcmeWebhookPayloadConverter::class)]
        private readonly PayloadConverterInterface $converter,
    ) {
    }

    // ... getRequestMatcher() as before

    protected function doParse(
        Request $request,
        #[\SensitiveParameter] string $secret,
    ): ?RemoteEvent {
        try {
            return $this->converter->convert($request->toArray());
        } catch (ParseException|\JsonException $e) {
            throw new RejectWebhookException(406, $e->getMessage(), $e);
        }
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

// src/RemoteEvent/MailerWebhookConsumer.php
namespace App\RemoteEvent;

use Symfony\Component\RemoteEvent\Attribute\AsRemoteEventConsumer;
use Symfony\Component\RemoteEvent\Consumer\ConsumerInterface;
use Symfony\Component\RemoteEvent\Event\Mailer\MailerDeliveryEvent;
use Symfony\Component\RemoteEvent\Event\Mailer\MailerEngagementEvent;
use Symfony\Component\RemoteEvent\RemoteEvent;

#[AsRemoteEventConsumer('mailer_mailgun')]
final class MailerWebhookConsumer implements ConsumerInterface
{
    public function consume(RemoteEvent $event): void
    {
        if ($event instanceof MailerDeliveryEvent) {
            $this->handleDelivery($event);
        } elseif ($event instanceof MailerEngagementEvent) {
            $this->handleEngagement($event);
        }
    }

    private function handleDelivery(MailerDeliveryEvent $event): void
    {
        // Update message status in database, log delivery, etc.
    }

    private function handleEngagement(MailerEngagementEvent $event): void
    {
        // Handle opens, clicks, bounces, etc.
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

// src/RemoteEvent/SmsWebhookConsumer.php
namespace App\RemoteEvent;

use Symfony\Component\RemoteEvent\Attribute\AsRemoteEventConsumer;
use Symfony\Component\RemoteEvent\Consumer\ConsumerInterface;
use Symfony\Component\RemoteEvent\Event\Sms\SmsEvent;
use Symfony\Component\RemoteEvent\RemoteEvent;

#[AsRemoteEventConsumer('notifier_twilio')]
final class SmsWebhookConsumer implements ConsumerInterface
{
    public function consume(RemoteEvent $event): void
    {
        if ($event instanceof SmsEvent) {
            $this->handleSms($event);
        }
    }

    private function handleSms(SmsEvent $event): void
    {
        // Update SMS delivery status in database, etc.
    }
}