Notification schemas
This page provides schema references for the notifications that Nylas v3 sends.
Keep in mind
You can send a request to the Webhook Mock Payload endpoint to get sample notification payloads on demand.
Grant notifications
You can subscribe to the following Grant triggers to be notified when changes are made:
Grant Created notifications
Nylas sends a grant.created notification when an end user successfully authenticates with your Nylas application for the first time, creating a user record or “grant”.
!!!include(v3_code_samples/webhooks/schemas/grant.created.json)!!!Grant Updated notifications
Nylas sends a grant.updated notification when a grant is modified, updated, or re-authenticated.
!!!include(v3_code_samples/webhooks/schemas/grant.updated.json)!!!Grant Deleted notifications
Nylas sends a grant.deleted notification when a grant is deleted as a result of a Delete Grant request.
!!!include(v3_code_samples/webhooks/schemas/grant.deleted.json)!!!Grant Expired notifications
Nylas sends a grant.expired notification when a grant’s credentials expire, usually because of a change in the user’s password on the provider.
!!!include(v3_code_samples/webhooks/schemas/grant.expired.json)!!!Calendar notifications
You can subscribe to the following Calendar triggers to be notified when changes are made:
Calendar Created notifications
Nylas sends a calendar.created notification when an end user creates a calendar.
!!!include(v3_code_samples/webhooks/schemas/calendar.created.json)!!!Calendar Updated notifications
Nylas sends a calendar.updated notification when an end user updates a calendar.
!!!include(v3_code_samples/webhooks/schemas/calendar.updated.json)!!!Calendar Deleted notifications
Nylas sends a calendar.deleted notification when an end user deletes a calendar.
!!!include(v3_code_samples/webhooks/schemas/calendar.deleted.json)!!!Event notifications
You can subscribe to the following Event triggers to be notified when changes are made:
Event Created notifications
Nylas sends an event.created notification when an event is created on an end user’s calendar.
!!!include(v3_code_samples/webhooks/schemas/event.created.json)!!!Event Updated notifications
Nylas sends an event.updated notification when an event is modified or updated. Nylas adds the occurrences parameter to the notification if the updated event is a single occurrence of a recurring Google event.
If the event is a single occurrence of a recurring event, Nylas includes the master_event_id field, as in the example below.
!!!include(v3_code_samples/webhooks/schemas/event.updated.json)!!!Event Deleted notifications
Nylas sends an event.deleted notification when an event is deleted from an end user’s calendar.
!!!include(v3_code_samples/webhooks/schemas/event.deleted.json)!!!Scheduler notifications
You can subscribe to the following Scheduler triggers to be notified when changes are made:
Booking Created notifications
Nylas sends a booking.created notification when a guest creates a booking.
!!!include(v3_code_samples/webhooks/schemas/booking.created.json)!!!Booking Pending notifications
Nylas sends a booking.pending notification when a guest schedules a pending booking that requires confirmation.
!!!include(v3_code_samples/webhooks/schemas/booking.pending.json)!!!Booking Rescheduled notifications
Nylas sends a booking.rescheduled notification when a guest reschedules a booking.
!!!include(v3_code_samples/webhooks/schemas/booking.rescheduled.json)!!!Booking Deleted notifications
Nylas sends a booking.cancelled notification when a guest cancels a booking.
!!!include(v3_code_samples/webhooks/schemas/booking.cancelled.json)!!!Message notifications
You can subscribe to the following Message triggers to be notified when changes are made:
message.createdmessage.updatedmessage.send_success(scheduled messages only)message.send_failed(scheduled messages only)message.bounce_detected(Available for Google, Microsoft Graph, iCloud, and Yahoo.)
Message Created notifications
Nylas sends a message.created notification when an email message is created.
!!!include(v3_code_samples/webhooks/schemas/message.created.json)!!!Message Updated notifications
Nylas sends a message.updated notification when an email message is modified or updated.
!!!include(v3_code_samples/webhooks/schemas/message.updated.json)!!!Message Send Success notifications
Nylas sends a message.send_success notification when a scheduled email message is sent and delivered successfully. You must set the send_at parameter in an email message to use this trigger.
!!!include(v3_code_samples/webhooks/schemas/message.send_success.json)!!!Message Send Failed notifications
Nylas sends a message.send_failed notification when a scheduled email message is sent, but not delivered. You must set the send_at parameter in an email message to use this trigger.
!!!include(v3_code_samples/webhooks/schemas/message.send_failed.json)!!!Message Bounce Detected notifications
Nylas sends a message.bounce_detected notification when an email message bounces or is not delivered. You can subscribe to the trigger so you can notify end users when an email message bounces. This trigger is currently available for Google, Microsoft Graph, iCloud, and Yahoo.
!!!include(v3_code_samples/webhooks/schemas/message.bounce_detected.json)!!!Message tracking notifications
You can subscribe to the following triggers to be notified when a tracking trigger is fulfilled on email messages with tracking enabled:
See the message tracking documentation for more information.
Message Opened notifications
Nylas sends a message.opened notification when a participant first opens a tracked email message.
!!!include(v3_code_samples/webhooks/schemas/message.opened.json)!!!Link Clicked notifications
Nylas sends a message.link_clicked notification when a participant clicks a link in a tracked email message.
!!!include(v3_code_samples/webhooks/schemas/message.link_clicked.json)!!!Thread Replied notifications
Nylas sends a thread.replied notification when a participant replies to a tracked email thread.
!!!include(v3_code_samples/webhooks/schemas/thread.replied.json)!!!ExtractAI notifications
You can subscribe to the following Order Consolidation triggers to be notified when an end user receives an email message with order or tracking information:
Order notifications
Nylas sends a message.intelligence.order notification when an end user receives an email message that contains information about an e-commerce order.
!!!include(v3_code_samples/webhooks/schemas/message.intelligence.order.json)!!!Order Tracking notifications
Nylas sends a message.intelligence.tracking notification when an end user receives an email message that contains tracking information for an e-commerce order.
!!!include(v3_code_samples/webhooks/schemas/message.intelligence.tracking.json)!!!Folder notifications
You can subscribe to the following Folder triggers to be notified when changes are made:
Folder Created notifications
Nylas sends a folder.created notification when an end user creates a folder.
!!!include(v3_code_samples/webhooks/schemas/folder.created.json)!!!Folder Updated notifications
Nylas sends a folder.updated notification when an end user updates a folder.
!!!include(v3_code_samples/webhooks/schemas/folder.updated.json)!!!Folder Deleted notifications
Nylas sends a folder.deleted notification when an end user deletes a folder.
!!!include(v3_code_samples/webhooks/schemas/folder.deleted.json)!!!Contact notifications
You can subscribe to the following Contact triggers to be notified when changes are made:
contact.updatedcontact.deleted
Contact Updated notifications
Nylas sends a contact.udpated notification when an contact is created or updated.
Most providers do not differentiate between these two actions in their APIs, so Nylas sends a contact.updated notification for both actions.
!!!include(v3_code_samples/webhooks/schemas/contact.updated.json)!!!Contact Deleted notifications
Nylas sends a contact.deleted notification when an contact is deleted.
!!!include(v3_code_samples/webhooks/schemas/contact.deleted.json)!!!