diff --git a/.changeset/calm-emails-block.md b/.changeset/calm-emails-block.md new file mode 100644 index 00000000000..ca04c300599 --- /dev/null +++ b/.changeset/calm-emails-block.md @@ -0,0 +1,5 @@ +--- +'@clerk/backend': patch +--- + +Add `transactional_email_blocked` to the `ClerkPolicy` reasons of the `email.suppressed` webhook event type. Clerk sends this reason when a queued transactional email is suppressed because sending was blocked for the instance. diff --git a/packages/backend/src/__tests__/email-outcomes.test.ts b/packages/backend/src/__tests__/email-outcomes.test.ts index 29f0ae98f8b..5411e8701b9 100644 --- a/packages/backend/src/__tests__/email-outcomes.test.ts +++ b/packages/backend/src/__tests__/email-outcomes.test.ts @@ -28,7 +28,10 @@ describe('transactional email outcome webhooks', () => { type Suppressed = Extract; type Policy = Extract; expectTypeOf().toEqualTypeOf< - 'unverified_email_dns' | 'provider_domain_restriction' | 'application_communication_lock' + | 'unverified_email_dns' + | 'provider_domain_restriction' + | 'application_communication_lock' + | 'transactional_email_blocked' >(); type Failed = Extract; expectTypeOf().toEqualTypeOf< diff --git a/packages/backend/src/api/resources/Webhooks.ts b/packages/backend/src/api/resources/Webhooks.ts index a8974b847a9..7b3bb11edc8 100644 --- a/packages/backend/src/api/resources/Webhooks.ts +++ b/packages/backend/src/api/resources/Webhooks.ts @@ -76,7 +76,11 @@ export type EmailDeliveryWebhookEvent = | { type: 'OnProviderSuppressionList'; message: string } | { type: 'ClerkPolicy'; - reason: 'unverified_email_dns' | 'provider_domain_restriction' | 'application_communication_lock'; + reason: + | 'unverified_email_dns' + | 'provider_domain_restriction' + | 'application_communication_lock' + | 'transactional_email_blocked'; message: string; }; }