Skip to content
Skip to main content

Webhook delivery and notification updates

PlatformEmail

Added

Section titled “Added”

  • Compressed webhook delivery — Webhook destinations, Amazon SNS channels, and Google Pub/Sub channels now accept a compressed_delivery boolean on create and update. When set to true, Nylas gzip-compresses the JSON payload before sending it. Two reasons to turn it on:

    • Avoids SNS’s 256 KB payload limit. Uncompressed notifications with long message bodies or large headers can be truncated; compressed delivery keeps them under the cap.
    • Bypasses WAF rules that block HTML in request bodies. Some firewalls reject notifications because the body field contains raw HTML; gzipped payloads no longer trip those rules.

    Configure it on webhook destinations, SNS channels, or Pub/Sub channels.

  • message.created.cleaned webhook trigger — A new trigger for projects using Clean Conversations. When subscribed, Nylas cleans inbound messages during sync and delivers the cleaned markdown in the webhook payload’s body field instead of the original HTML — no extra API call required. The trigger composes with the existing suffixes, so you may receive message.created.cleaned.transformed, message.created.cleaned.truncated, or message.created.cleaned.transformed.truncated. Subscribe once to message.created.cleaned and handle the suffix variants in your webhook processor. See the notification schema and the parse-messages guide for the end-to-end flow.

Fixed

Section titled “Fixed”
  • IMAP sync completed notification schema — The notification reference for IMAP sync completed previously listed the field as integartion_id. The actual webhook payload has always shipped integration_id; only the schema docs and example payload carried the typo. Both are now corrected.