Skip to content

[Mailer][Sweego] Add support for new webhook events #61555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicolas-grekas merged 1 commit into from
Aug 29, 2025
Merged

[Mailer][Sweego] Add support for new webhook events #61555

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion src/Symfony/Component/Mailer/Bridge/Sweego/RemoteEvent/SweegoPayloadConverter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,32 @@

use Symfony\Component\RemoteEvent\Event\Mailer\AbstractMailerEvent;
use Symfony\Component\RemoteEvent\Event\Mailer\MailerDeliveryEvent;
use Symfony\Component\RemoteEvent\Event\Mailer\MailerEngagementEvent;
use Symfony\Component\RemoteEvent\Exception\ParseException;
use Symfony\Component\RemoteEvent\PayloadConverterInterface;

final class SweegoPayloadConverter implements PayloadConverterInterface
{
public function convert(array $payload): AbstractMailerEvent
{
if (\in_array($payload['event_type'], ['email_sent', 'delivered'], true)) {
if (\in_array($payload['event_type'], ['email_sent', 'delivered', 'soft-bounce', 'hard_bounce'], true)) {
$name = match ($payload['event_type']) {
'email_sent' => MailerDeliveryEvent::RECEIVED,
'delivered' => MailerDeliveryEvent::DELIVERED,
'soft-bounce', 'hard_bounce' => MailerDeliveryEvent::BOUNCE,
};

$event = new MailerDeliveryEvent($name, $payload['headers']['x-transaction-id'], $payload);
} else {
$name = match ($payload['event_type']) {
'list_unsub' => MailerEngagementEvent::UNSUBSCRIBE,
'complaint' => MailerEngagementEvent::SPAM,
'email_clicked' => MailerEngagementEvent::CLICK,
'email_opened' => MailerEngagementEvent::OPEN,
default => throw new ParseException(\sprintf('Unsupported event "%s".', $payload['event_type'])),
};

$event = new MailerEngagementEvent($name, $payload['headers']['x-transaction-id'], $payload);
}

if (!$date = \DateTimeImmutable::createFromFormat(\DATE_ATOM, $payload['timestamp'])) {
Expand Down
22 changes: 22 additions & 0 deletions src/Symfony/Component/Mailer/Bridge/Sweego/Tests/Webhook/Fixtures/complaint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"event_type": "complaint",
"timestamp": "2024-09-02T08:45:05+00:00",
"swg_uid": "01-47d3e283-1afb-4b9e-bd45-bfbf32ba251f",
"event_id": "3e42ea83-f6a5-40cc-a1fa-8745669454",
"channel": "email",
"transaction_id": "b0e50d6d-118c-459b-84e1-70209e68c1c9",
"headers": {
"x-mailer": "Sweego",
"x-swg-uid": "01-47d3ekdpj-1fdb-4bde-bsd5-bfbf32sdgf54f",
"x-campaign-id": "default",
"x-client-id": "0c8cc711c85e45b79189456644166sj",
"x-originating-ip": "185.255.28.207",
"x-campaign-type": "default",
"x-transaction-id": "b0e50d6d-118c-459b-84e1-70209e68c1c9"
},
"campaign_tags": null,
"campaign_type": "default",
"campaign_id": "default",
"recipient": "recipient@example.com",
"domain_from": "example.org"
}
18 changes: 18 additions & 0 deletions src/Symfony/Component/Mailer/Bridge/Sweego/Tests/Webhook/Fixtures/complaint.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?php

use Symfony\Component\RemoteEvent\Event\Mailer\MailerEngagementEvent;

$wh = new MailerEngagementEvent(MailerEngagementEvent::SPAM, 'b0e50d6d-118c-459b-84e1-70209e68c1c9', json_decode(file_get_contents(str_replace('.php', '.json', __FILE__)), true));
$wh->setRecipientEmail('recipient@example.com');
$wh->setMetadata([
'x-mailer' => 'Sweego',
'x-swg-uid' => '01-47d3ekdpj-1fdb-4bde-bsd5-bfbf32sdgf54f',
'x-campaign-id' => 'default',
'x-client-id' => '0c8cc711c85e45b79189456644166sj',
'x-originating-ip' => '185.255.28.207',
'x-campaign-type' => 'default',
'x-transaction-id' => 'b0e50d6d-118c-459b-84e1-70209e68c1c9',
]);
$wh->setDate(\DateTimeImmutable::createFromFormat(\DATE_ATOM, '2024-09-02T08:45:05+00:00'));

return $wh;
7 changes: 7 additions & 0 deletions src/Symfony/Component/Mailer/Bridge/Sweego/Tests/Webhook/Fixtures/delivered.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@
"event_id": "9f26b9d0-13d7-410c-ba04-5019cd30e6d0",
"channel": "email",
"headers": {
"x-campaign-type": "default",
"x-swg-uid": "01-f14sqdf65-fgh9b6-4160-bc45-fliolioa277ca9",
"x-mailer": "Sweego",
"x-campaign-id": "default",
"x-client-id": "0c8cc711c85e4595953862",
"x-originating-ip": "XXX.XXX.XXX.XX",
"x-email-id": "23",
"x-transaction-id": "d4fbec9d-eed9-44d5-af47-c1126467a5ca"
},
"campaign_tags": null,
Expand Down
7 changes: 7 additions & 0 deletions src/Symfony/Component/Mailer/Bridge/Sweego/Tests/Webhook/Fixtures/delivered.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@
$wh = new MailerDeliveryEvent(MailerDeliveryEvent::DELIVERED, 'd4fbec9d-eed9-44d5-af47-c1126467a5ca', json_decode(file_get_contents(str_replace('.php', '.json', __FILE__)), true));
$wh->setRecipientEmail('recipient@example.com');
$wh->setMetadata([
'x-campaign-type' => 'default',
'x-swg-uid' => '01-f14sqdf65-fgh9b6-4160-bc45-fliolioa277ca9',
'x-mailer' => 'Sweego',
'x-campaign-id' => 'default',
'x-client-id' => '0c8cc711c85e4595953862',
'x-originating-ip' => 'XXX.XXX.XXX.XX',
'x-email-id' => '23',
'x-transaction-id' => 'd4fbec9d-eed9-44d5-af47-c1126467a5ca',
]);
$wh->setDate(\DateTimeImmutable::createFromFormat(\DATE_ATOM, '2024-08-15T16:05:59+00:00'));
Expand Down
30 changes: 30 additions & 0 deletions src/Symfony/Component/Mailer/Bridge/Sweego/Tests/Webhook/Fixtures/email_clicked.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"event_type": "email_clicked",
"timestamp": "2024-09-02T08:45:05+00:00",
"swg_uid": "02-6e5dbe48-e6f4-4af3-8fb4-bf125e75776b",
"event_id": "3e434a94-628c-4cbd-92b5-ed6be715aa2c",
"channel": "email",
"transaction_id": "568c5678-2d03-40f8-89e0-22ffb5cfe63d",
"headers": {
"x-mailer": "Sweego",
"x-swg-uid": "02-6e5dbe48-e6f4-4af3-8fb4-bf125e75776b",
"x-client-id": "f8367456332369298d050cf4bc83e058",
"x-client-ip": "XXX.XXX.XXX.XXX",
"x-campaign-id": "fake_campaign",
"x-campaign-type": "default",
"x-originating-ip": "XXX.XXX.XXX.XXX",
"x-transaction-id": "568c5678-2d03-40f8-89e0-22ffb5cfe63d"
},
"campaign_tags": null,
"campaign_type": "default",
"campaign_id": "fake_campaign",
"recipient": "recipient@example.com",
"domain_from": "example.org",
"subject": "Test webhook 2024-01-01",
"click": {
"ip_address": "XXX.XXX.XXX.XXX",
"url": "https://google.com",
"user_agent": "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)",
"proxy": false
}
}
19 changes: 19 additions & 0 deletions src/Symfony/Component/Mailer/Bridge/Sweego/Tests/Webhook/Fixtures/email_clicked.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?php

use Symfony\Component\RemoteEvent\Event\Mailer\MailerEngagementEvent;

$wh = new MailerEngagementEvent(MailerEngagementEvent::CLICK, '568c5678-2d03-40f8-89e0-22ffb5cfe63d', json_decode(file_get_contents(str_replace('.php', '.json', __FILE__)), true));
$wh->setRecipientEmail('recipient@example.com');
$wh->setMetadata([
'x-mailer' => 'Sweego',
'x-swg-uid' => '02-6e5dbe48-e6f4-4af3-8fb4-bf125e75776b',
'x-client-id' => 'f8367456332369298d050cf4bc83e058',
'x-client-ip' => 'XXX.XXX.XXX.XXX',
'x-campaign-id' => 'fake_campaign',
'x-campaign-type' => 'default',
'x-originating-ip' => 'XXX.XXX.XXX.XXX',
'x-transaction-id' => '568c5678-2d03-40f8-89e0-22ffb5cfe63d',
]);
$wh->setDate(\DateTimeImmutable::createFromFormat(\DATE_ATOM, '2024-09-02T08:45:05+00:00'));

return $wh;
29 changes: 29 additions & 0 deletions src/Symfony/Component/Mailer/Bridge/Sweego/Tests/Webhook/Fixtures/email_opened.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"event_type": "email_opened",
"timestamp": "2024-09-02T08:45:05+00:00",
"swg_uid": "02-6e5dbe48-e6f4-4af3-8fb4-bf125e75776b",
"event_id": "3e434a94-628c-4cbd-92b5-ed6be715aa2c",
"channel": "email",
"transaction_id": "69b90094-872f-4250-97d5-515ac7114b1b",
"headers": {
"x-mailer": "Sweego",
"x-swg-uid": "02-6e5dbe48-e6f4-4af3-8fb4-bf125e75776b",
"x-client-id": "f8367456332593298d050cf4bc83e0ab",
"x-client-ip": "XXX.XXX.XXX.XXX",
"x-campaign-id": "fake_campaign",
"x-campaign-type": "default",
"x-originating-ip": "XXX.XXX.XXX.XXX",
"x-transaction-id": "69b90094-872f-4250-97d5-515ac7114b1b"
},
"campaign_tags": null,
"campaign_type": "default",
"campaign_id": "fake_campaign",
"recipient": "recipient@example.com",
"domain_from": "example.org",
"subject": "Test webhook",
"open": {
"ip_address": "XXX.XXX.XXX.XXX",
"user_agent": "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)",
"proxy": true
}
}
19 changes: 19 additions & 0 deletions src/Symfony/Component/Mailer/Bridge/Sweego/Tests/Webhook/Fixtures/email_opened.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?php

use Symfony\Component\RemoteEvent\Event\Mailer\MailerEngagementEvent;

$wh = new MailerEngagementEvent(MailerEngagementEvent::OPEN, '69b90094-872f-4250-97d5-515ac7114b1b', json_decode(file_get_contents(str_replace('.php', '.json', __FILE__)), true));
$wh->setRecipientEmail('recipient@example.com');
$wh->setMetadata([
'x-mailer' => 'Sweego',
'x-swg-uid' => '02-6e5dbe48-e6f4-4af3-8fb4-bf125e75776b',
'x-client-id' => 'f8367456332593298d050cf4bc83e0ab',
'x-client-ip' => 'XXX.XXX.XXX.XXX',
'x-campaign-id' => 'fake_campaign',
'x-campaign-type' => 'default',
'x-originating-ip' => 'XXX.XXX.XXX.XXX',
'x-transaction-id' => '69b90094-872f-4250-97d5-515ac7114b1b',
]);
$wh->setDate(\DateTimeImmutable::createFromFormat(\DATE_ATOM, '2024-09-02T08:45:05+00:00'));

return $wh;
23 changes: 23 additions & 0 deletions src/Symfony/Component/Mailer/Bridge/Sweego/Tests/Webhook/Fixtures/email_sent.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"event_type": "email_sent",
"timestamp": "2024-09-02T08:45:05+00:00",
"swg_uid": "01-47d3e283-1afb-4b9e-bd45-bfbf32ba251f",
"event_id": "3e42ea83-f6a5-40cc-a1fa-8745669454",
"channel": "email",
"transaction_id": "8a3bf3ee-1863-4a02-906d-2e6494914ddb",
"headers": {
"x-campaign-type": "default",
"x-swg-uid": "01-47d3ekdpj-1fdb-4bde-bsd5-bfbf32sdgf54f",
"x-mailer": "Sweego",
"x-campaign-id": "default",
"x-client-id": "0c8cc711c85e45b79189456644166sj",
"x-originating-ip": "185.255.28.207",
"x-email-id": "23",
"x-transaction-id": "8a3bf3ee-1863-4a02-906d-2e6494914ddb"
},
"campaign_tags": null,
"campaign_type": "default",
"campaign_id": "default",
"recipient": "recipient@example.com",
"domain_from": "example.org"
}
19 changes: 19 additions & 0 deletions src/Symfony/Component/Mailer/Bridge/Sweego/Tests/Webhook/Fixtures/email_sent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?php

use Symfony\Component\RemoteEvent\Event\Mailer\MailerDeliveryEvent;

$wh = new MailerDeliveryEvent(MailerDeliveryEvent::RECEIVED, '8a3bf3ee-1863-4a02-906d-2e6494914ddb', json_decode(file_get_contents(str_replace('.php', '.json', __FILE__)), true));
$wh->setRecipientEmail('recipient@example.com');
$wh->setMetadata([
'x-campaign-type' => 'default',
'x-swg-uid' => '01-47d3ekdpj-1fdb-4bde-bsd5-bfbf32sdgf54f',
'x-mailer' => 'Sweego',
'x-campaign-id' => 'default',
'x-client-id' => '0c8cc711c85e45b79189456644166sj',
'x-originating-ip' => '185.255.28.207',
'x-email-id' => '23',
'x-transaction-id' => '8a3bf3ee-1863-4a02-906d-2e6494914ddb',
]);
$wh->setDate(\DateTimeImmutable::createFromFormat(\DATE_ATOM, '2024-09-02T08:45:05+00:00'));

return $wh;
27 changes: 27 additions & 0 deletions src/Symfony/Component/Mailer/Bridge/Sweego/Tests/Webhook/Fixtures/hard_bounce.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"event_type": "hard_bounce",
"timestamp": "2024-08-20T08:48:35+00:00",
"swg_uid": "01-68d20f85-253e-4986-b7f0-0e4229df4d61",
"event_id": "88eaff9a-5087-47d9-afdd-6eeaddfb11ae",
"channel": "email",
"transaction_id": "8dea05e7-9e8b-43d7-b000-3f7d15304162",
"headers": {
"x-swg-uid": "01-68d20f85-253e-4986-b7f0-0e4229df4d61",
"x-client-id": "myid",
"x-campaign-pool": "default",
"x-campaign-canal": "mycanal",
"x-campaign-type": "default",
"x-mailer": "Sweego",
"x-originating-ip": "XXX.XXX.XXX.XXX",
"x-campaign-ref": "895000#N",
"x-campaign-id": "b205d7b6-9eb5-4ba7-b3b9-5e2b8cade053",
"x-transaction-id": "8dea05e7-9e8b-43d7-b000-3f7d15304162"
},
"campaign_tags": null,
"campaign_type": "default",
"campaign_id": "default",
"recipient": "recipient@example.com",
"domain_from": "example.org",
"response_code": 550,
"status": null
}
21 changes: 21 additions & 0 deletions src/Symfony/Component/Mailer/Bridge/Sweego/Tests/Webhook/Fixtures/hard_bounce.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<?php

use Symfony\Component\RemoteEvent\Event\Mailer\MailerDeliveryEvent;

$wh = new MailerDeliveryEvent(MailerDeliveryEvent::BOUNCE, '8dea05e7-9e8b-43d7-b000-3f7d15304162', json_decode(file_get_contents(str_replace('.php', '.json', __FILE__)), true));
$wh->setRecipientEmail('recipient@example.com');
$wh->setMetadata([
'x-swg-uid' => '01-68d20f85-253e-4986-b7f0-0e4229df4d61',
'x-client-id' => 'myid',
'x-campaign-pool' => 'default',
'x-campaign-canal' => 'mycanal',
'x-campaign-type' => 'default',
'x-mailer' => 'Sweego',
'x-originating-ip' => 'XXX.XXX.XXX.XXX',
'x-campaign-ref' => '895000#N',
'x-campaign-id' => 'b205d7b6-9eb5-4ba7-b3b9-5e2b8cade053',
'x-transaction-id' => '8dea05e7-9e8b-43d7-b000-3f7d15304162',
]);
$wh->setDate(\DateTimeImmutable::createFromFormat(\DATE_ATOM, '2024-08-20T08:48:35+00:00'));

return $wh;
28 changes: 28 additions & 0 deletions src/Symfony/Component/Mailer/Bridge/Sweego/Tests/Webhook/Fixtures/list_unsub.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"event_type": "list_unsub",
"timestamp": "2024-09-02T12:55:09+00:00",
"swg_uid": "02-5898484-484f2-841d-84ea-a33351589aabc0",
"event_id": "0a190ab5-aad8-4874-9c32-0848484f8fc",
"channel": "email",
"transaction_id": "861aad97-e4e8-4aaf-9322-1b64835760b9",
"headers": {
"x-campaign-id": "42",
"x-campaign-tags": "billing",
"x-campaign-type": "transac",
"x-client-id": "d6b1222eb484fb8f4g8d4fg8cd4",
"x-client-ip": "XXX.XXX.XXX.XXX",
"x-mailer": "Sweeg",
"x-originating-ip": "XXX.XXX.XXX.XXX",
"x-ref-1": "643524",
"x-ref-2": "lervcn",
"x-ref-3": "o10icr",
"x-swg-uid": "02-589edd0e-b7f2-4a1d-a3ea-a333cb9aabc0",
"x-transaction-id": "861aad97-e4e8-4aaf-9322-1b64835760b9"
},
"campaign_tags": "billing",
"campaign_type": "transac",
"campaign_id": "transac",
"recipient": "recipient@example.com",
"domain_from": "example.org",
"one_click": false
}
23 changes: 23 additions & 0 deletions src/Symfony/Component/Mailer/Bridge/Sweego/Tests/Webhook/Fixtures/list_unsub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?php

use Symfony\Component\RemoteEvent\Event\Mailer\MailerEngagementEvent;

$wh = new MailerEngagementEvent(MailerEngagementEvent::UNSUBSCRIBE, '861aad97-e4e8-4aaf-9322-1b64835760b9', json_decode(file_get_contents(str_replace('.php', '.json', __FILE__)), true));
$wh->setRecipientEmail('recipient@example.com');
$wh->setMetadata([
'x-campaign-id' => '42',
'x-campaign-tags' => 'billing',
'x-campaign-type' => 'transac',
'x-client-id' => 'd6b1222eb484fb8f4g8d4fg8cd4',
'x-client-ip' => 'XXX.XXX.XXX.XXX',
'x-mailer' => 'Sweeg',
'x-originating-ip' => 'XXX.XXX.XXX.XXX',
'x-ref-1' => '643524',
'x-ref-2' => 'lervcn',
'x-ref-3' => 'o10icr',
'x-swg-uid' => '02-589edd0e-b7f2-4a1d-a3ea-a333cb9aabc0',
'x-transaction-id' => '861aad97-e4e8-4aaf-9322-1b64835760b9',
]);
$wh->setDate(\DateTimeImmutable::createFromFormat(\DATE_ATOM, '2024-09-02T12:55:09+00:00'));

return $wh;
27 changes: 27 additions & 0 deletions src/Symfony/Component/Mailer/Bridge/Sweego/Tests/Webhook/Fixtures/soft-bounce.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"event_type": "soft-bounce",
"timestamp": "2024-08-20T08:38:27+00:00",
"swg_uid": "01-4f5qsdqsd3-b5e1-4012-a350-2e3d0d176ef1",
"event_id": "82ebfgbfgb-0fgbfg-4190-967c-2e8484212f1c0f",
"channel": "email",
"transaction_id": "861aad97-e4e8-4aaf-9322-1b64835760b9",
"headers": {
"x-campaign-type": "default",
"x-swg-uid": "01-4f5e28484-b515-4848-1956-2e3d0d176ef1",
"x-mailer": "Sweego",
"x-client-id": "MypersonnalId",
"x-originating-ip": "XXX.XXX.XXX.XXX",
"x-campaign-ref": "895000N",
"x-campaign-pool": "default",
"x-campaign-id": "b20dsfsdfds6-9595b5-9595a7-565b9-5e2b826595053",
"x-campaign-canal": "mycanal",
"x-transaction-id": "f11f4fe2-fb05-4882-8303-a20956d47931"
},
"campaign_tags": null,
"campaign_type": "default",
"campaign_id": "default",
"recipient": "recipient@example.com",
"domain_from": "example.org",
"response_code": 452,
"status": null
}
Loading
Loading