Create a Pub/Sub channel - Pubsub Notifications - API Reference

POST

/v3/channels/pubsub

Create a Pub/Sub channel in the specified application.

NYLAS API KEY

Request body

Destination definition

descriptionstring

A human-readable description of the Pub/Sub channel.

Example: "Production Pub/Sub for Events notifications"

trigger_types*array<string>

The event that triggers the notification. See the notification schemas for details about each trigger type.

See the Grants, Calendar, Events, and Messages references for information on how to trigger each event type.

topicstring

The Google Pub/Sub topic that Nylas sends notifications to.

Example: "projects/your-project-id/topics/your-topic-id"

notification_email_addressesarray<string>

The email addresses that Nylas notifies if delivery to the Pub/Sub channel fails.

Example: ["[email protected]","[email protected]"]

compressed_deliveryboolean

If true, Nylas compresses notification payloads using gzip before delivering them. Nylas adds a content_encoding: gzip message attribute to the Pub/Sub message. Default is false.

Default: false

Example: true

Responses

dataobject

request_idstring

The unique ID of the request that generated this response.

curl --request POST \ --url 'https://api.us.nylas.com/v3/channels/pubsub' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <NYLAS_API_KEY>' \ --data-raw '{ "description": "PubSub Test", "trigger_types": ["message.send_success"], "encryption_key": "", "topic": "projects/<YOUR_PROJECT_ID>/topics/<YOUR_TOPIC_ID>", "notification_email_addresses": ["[email protected]"] }'