Skip to content

Notification scopes

This page lists the notification triggers available in Nylas v3, and shows which scopes they require. For more information about scopes in Nylas v3, see the Authentication scopes documentation.

All scopes must include the fully qualified URI path for the provider. The table shortens the full scope URI for space reasons, so add the prefix for the provider when requesting scopes.

The ☑️ in each column indicates the most restrictive scope you can request for each provider and still use that API. More permissive scopes appear under the minimum option. If you’re already using one of the permissive scopes, you don’t need to add the more restrictive scope.

Notification triggerGoogle Scopes
https://www.googleapis.com/auth/...
Microsoft Scopes
https://graph.microsoft.com/...

calendar.created
calendar.updated
calendar.deleted

/calendar.events.readonly ☑️
/calendar.events

Calendars.Read ☑️
Calendars.Read.Shared
Calendars.ReadWrite
Calendars.ReadWrite.Shared

event.created
event.updated
event.deleted

/calendar.events.readonly ☑️
/calendar.readonly ☑️
/calendar.events

Calendars.Read ☑️
Calendars.Read.Shared
Calendars.ReadWrite
Calendars.ReadWrite.Shared

message.send_success
message.send_failed

/gmail.send ☑️

Mail.ReadWrite ☑️
Mail.Send ☑️

message.created
message.updated

/gmail.readonly ☑️
/gmail.modify

Mail.Read ☑️
Mail.ReadWrite
Mail.ReadWrite.Shared
Mail.Read.Shared

message.bounce_detected

/gmail.readonly ☑️
/gmail.send ☑️
/gmail.modify

Mail.Read ☑️
Mail.Send ☑️
Mail.ReadWrite
Mail.Send

thread.replied

/gmail.readonly ☑️
/gmail.send ☑️
/gmail.modify

Mail.Read ☑️
Mail.Send ☑️
Mail.ReadWrite
Mail.Send

folder.created
folder.updated
folder.deleted

/gmail.readonly ☑️
/gmail.labels (with refactor)
/gmail.modify

Mail.Read ☑️
Mail.ReadWrite
Mail.ReadWrite.Shared
Mail.Read.Shared