Amazon SNS Notifications
Amazon SNS notification channels allow you to receive Nylas event notifications through Amazon Simple Notification Service (SNS) instead of webhooks.
To use Amazon SNS notifications, you need to set up an SNS topic and an IAM role in your AWS account. The topic ARN must start with arn:aws:sns:. The IAM role must allow Nylas to assume it via STS AssumeRoleWithWebIdentity and must have sns:Publish permission on the topic. For detailed set up instructions, see the Amazon SNS notification channel documentation.
The Amazon SNS notification channels use the same notification trigger types and schemas as webhook notifications, and require the same provider scopes.
Nylas strongly recommends setting compressed_delivery to true when you create an SNS channel. SNS enforces a 256 KB message size limit, and gzip compression is the simplest way to keep large message.* notifications inside it. Nylas adds a content_encoding: gzip+base64 message attribute so your subscriber knows which messages to decompress. For setup and the decode pattern, see Reducing payload size with compression.
GET /v3/channels/snsGet the Amazon SNS notification channels for an application.
POST /v3/channels/snsCreate an Amazon SNS notification channel in the specified application. The topic must be a valid Amazon SNS topic ARN (starting with arn:aws:sns:).
GET /v3/channels/sns/{id}Get a specific Amazon SNS notification channel from a specific Nylas application.
PUT /v3/channels/sns/{id}Updates the specified Amazon SNS notification channel. When you make a PUT request, Nylas replaces all data in the nested object with the information included in your request. For more information, se...
DELETE /v3/channels/sns/{id}Delete a specific Amazon SNS notification channel from a specific Nylas application.