NYnylas
Webhook Notifications
Pub/Sub Notifications

Get mock notification payload

Use this endpoint to see example notification payloads for the different Nylas events you specify, to the webhook URL you specify.

post/v3/webhooks/mock-payload

Request

  • Base URL
    https://api.us.nylas.com
  • Auth
    HTTP bearer

Request body

trigger_type'calendar.created' | 'calendar.updated' | 'calendar.deleted' | 'event.created' | 'event.updated' | 'event.deleted' | 'grant.created' | 'grant.updated' | 'grant.deleted' | 'grant.expired' | 'message.send_success' | 'message.send_failed' | 'message.bounce_detected' | 'message.created' | 'message.created.truncated' | 'message.created.cleaned' | 'message.updated' | 'message.updated.truncated' | 'contact.updated' | 'contact.deleted' | 'folder.created' | 'folder.updated' | 'folder.deleted' | 'message.opened' | 'message.link_clicked' | 'thread.replied' required

The event that will trigger the mock 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.

You can test message.created.truncated and message.updated.truncated notifications using this endpoint. For more information, see Truncated webhooks.

Response

Webhook Payload Returned

request_idstring

The ID for each request.

Changes

No recorded changes to this operation across all 16 revisions of this API.