Nylas Notifications

# Nylas Notifications — AsyncAPI 3.1. Authored by Nylas; see info.x-provenance.
asyncapi: 3.0.0
id: urn:com:nylas:v3:notifications
info:
  title: Nylas Notifications
  version: v3
  description: 'Change notifications Nylas pushes for grants, messages, message tracking, folders, calendars, events,
    contacts, Scheduler bookings, Notetaker, ExtractAI, Transactional Email and Agent Accounts. Every notification
    is a CloudEvents 1.0 envelope whose `data.object` carries the affected resource. The same payloads are delivered
    over three interchangeable transports: an HTTPS webhook to an endpoint you register, a Google Cloud Pub/Sub
    topic in your project, or an Amazon SNS topic in your AWS account. Nylas guarantees at-least-once delivery,
    so deduplicate on the envelope `id`. Payloads over 1 MB are truncated for `message.*` triggers and carry a `.truncated`
    suffix on `type`; `.cleaned` and `.transformed` suffixes can also combine. Subscribe to triggers with POST /v3/webhooks,
    POST /v3/channels/pubsub or POST /v3/channels/sns.'
  contact:
    name: Nylas Support
    url: https://developer.nylas.com/docs/support/
  license:
    name: Nylas Terms of Service
    url: https://www.nylas.com/legal/terms/
  externalDocs:
    description: Using webhooks with Nylas
    url: https://developer.nylas.com/docs/v3/notifications/
  tags:
  - name: Grants
    description: Notifications about grant lifecycle events including creation, updates, expiration, and deletion.
    externalDocs:
      url: https://developer.nylas.com/docs/reference/notifications/grants/
  - name: Messages
    description: Notifications about email message events — new messages, updates, send results, bounces, and tracking.
    externalDocs:
      url: https://developer.nylas.com/docs/reference/notifications/messages/
  - name: Message Tracking
    description: Notifications for tracked message opens, link clicks, and replies.
    externalDocs:
      url: https://developer.nylas.com/docs/reference/notifications/message-tracking/
  - name: Message Metadata
    description: Limited notifications for Google accounts using the gmail.metadata scope.
    externalDocs:
      url: https://developer.nylas.com/docs/reference/notifications/message-metadata/
  - name: Folders and Labels
    description: Notifications about email folder and label events.
    externalDocs:
      url: https://developer.nylas.com/docs/reference/notifications/folders/
  - name: Calendar
    description: Notifications about calendar creation, modification, and deletion.
    externalDocs:
      url: https://developer.nylas.com/docs/reference/notifications/calendar/
  - name: Events
    description: Notifications about calendar event creation, modification, and deletion.
    externalDocs:
      url: https://developer.nylas.com/docs/reference/notifications/events/
  - name: Contacts
    description: Notifications about contact creation, modification, and deletion.
    externalDocs:
      url: https://developer.nylas.com/docs/reference/notifications/contacts/
  - name: Scheduler
    description: Notifications about booking events from Nylas Scheduler.
    externalDocs:
      url: https://developer.nylas.com/docs/reference/notifications/scheduler/
  - name: Notetaker
    description: Notifications about Notetaker bot lifecycle, meeting states, and media processing.
    externalDocs:
      url: https://developer.nylas.com/docs/reference/notifications/notetaker/
  - name: ExtractAI
    description: Notifications when ExtractAI detects e-commerce orders, tracking, or returns in email messages.
    externalDocs:
      url: https://developer.nylas.com/docs/reference/notifications/extractai/
  - name: Transactional Email
    description: Delivery status notifications for transactional emails.
    externalDocs:
      url: https://developer.nylas.com/docs/reference/notifications/transactional-email/


# --- truncated at 32 KB (131 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nylas/refs/heads/main/asyncapi/nylas-notifications-asyncapi.yml