How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Nylas

Nylas Notifications API

Change notifications. Nylas pushes events for messages, threads, calendars, events, grants and Notetaker over three interchangeable transports carrying the same payloads: HTTPS webhooks, Google Cloud Pub/Sub, and Amazon SNS. Covers subscription CRUD, delivery testing, mock payloads and the source IP ranges to allowlist. There is no polling requirement, and no WebSocket or SSE surface.

Documentation Provider Profile APIs.io OpenAPI GitHub

Nylas Notifications API is one of 13 APIs that Nylas publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Webhook, Notification, and Event. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 18 operations across 9 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version v3.

Requests are made against 2 base URLs: https://api.us.nylas.com, https://api.eu.nylas.com.

18 operations 9 paths 7 schemas 3 DELETE6 GET6 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v3
Base URL
https://api.us.nylas.com
Authentication
HTTP Bearer, HTTP Bearer
Contact
https://www.nylas.com/
Resource Areas
1

Authentication & Security 2

Nylas Notifications API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (NYLAS_ACCESS_TOKEN) (ACCESS_TOKEN). It accepts HTTP bearer tokens (NYLAS_API_KEY) (NYLAS_API_KEY). By default, every request must be authenticated.

  • ACCESS_TOKEN — The Nylas access token for a specific grant. Issued as part of OAuth 2.1 flow token exchange.
  • NYLAS_API_KEY — The Nylas API key provides application-level access to APIs and all grants. You can generate these from the Dashboard. Learn more about [authorizing requests](…

Paths & Operations 18

Across 9 paths, the API surfaces 18 operations — 3 DELETE, 6 GET, 6 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Notifications 18
POST
/v3/webhooks
Create a webhook destination
post-webhook-destinations body → 200400
GET
/v3/webhooks
Get destinations for an application
get-webhook-destinations-application → 200400
GET
/v3/webhooks/{id}
Get the destinations for an application by webhook ID
get-webhook-by-id 1 param → 200400
PUT
/v3/webhooks/{id}
Update a webhook destination
put-webhook-by-id 1 param body → 200400
DELETE
/v3/webhooks/{id}
Delete a webhook destination
delete-webhook-by-id 1 param → 200400
POST
/v3/webhooks/rotate-secret/{id}
Rotate a webhook secret
post-new-secret 1 param → 200400
POST
/v3/webhooks/mock-payload
Get mock notification payload
get_mock_webhook_payload body → 200400
POST
/v3/webhooks/send-test-event
Send test event
send_test_event body → 200400
POST
/v3/channels/pubsub
Create a Pub/Sub channel
create-pubsub-channel body → 200400
GET
/v3/channels/pubsub
Get Pub/Sub channels for an application
get-pubsub-channels → 200400
GET
/v3/channels/pubsub/{id}
Get a specific Pub/Sub channel
get-pubsub-by-id 1 param → 200400
PUT
/v3/channels/pubsub/{id}
Update a Pub/Sub channel
put-pubsub-by-id 1 param body → 200400
DELETE
/v3/channels/pubsub/{id}
Delete a specific Pub/Sub channel
delete-pubsub-by-id 1 param → 200400
POST
/v3/channels/sns
Create an Amazon SNS channel
create-sns-channel body → 200400
GET
/v3/channels/sns
Get Amazon SNS channels for an application
get-sns-channels → 200400
GET
/v3/channels/sns/{id}
Get a specific Amazon SNS channel
get-sns-by-id 1 param → 200400
PUT
/v3/channels/sns/{id}
Update an Amazon SNS channel
put-sns-by-id 1 param body → 200400
DELETE
/v3/channels/sns/{id}
Delete a specific Amazon SNS channel
delete-sns-by-id 1 param → 200400

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are destination_update_payload (6 properties), amazon_sns_input_payload (6 properties), destination_input_payload (5 properties), pubsub_input_payload (5 properties). Each schema is shown below with its type and property counts.

pubsub_input_payload
object
5 properties 2 required
send_test_event_input
object
2 properties 2 required
trigger_types
array
The event that triggers the notification. See the [notification schemas](/docs/reference/notifications/) for details about each trigger type. See the [Grants](…
amazon_sns_input_payload
object
6 properties 3 required
get_mock_payload_input
object
1 property 2 required
destination_input_payload
object
5 properties 2 required
destination_update_payload
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nylas-notifications-api-openapi.yml Raw ↑

Other APIs Nylas publishes across the network.

Nylas Admin API
AE Profile APIs.io
Nylas Auth API
AE Profile APIs.io
Nylas Calendars API
AE Profile APIs.io
Nylas Contacts API
AE Profile APIs.io
Nylas Drafts API
AE Profile APIs.io
Nylas Events API
AE Profile APIs.io
Nylas Grants API
AE Profile APIs.io
Nylas Messages API
AE Profile APIs.io
Nylas Scheduling API
AE Profile APIs.io
Nylas Threads API
AE Profile APIs.io
Nylas Notetaker API
AE Profile APIs.io
Nylas Templates and Workflows API
AE Profile APIs.io
#Webhook#Notification#Event
← Back to N APIs
API Details
ID
nylas:nylas-notifications-api
Base URL
https://api.us.nylas.com
Docs
https://developer.nylas.com/docs/reference/notifications/
Provider
Nylas
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=nylas-notifications-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/nylas-notifications-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Nylas Notifications API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.