Get mock notification payload - Webhook Notifications - API Reference

POST

/v3/webhooks/mock-payload

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

NYLAS API KEY

Request body

Destination definition

trigger_type*string

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.

calendar.createdcalendar.updatedcalendar.deletedevent.createdevent.updatedevent.deletedgrant.createdgrant.updatedgrant.deletedgrant.expiredmessage.send_successmessage.send_failedmessage.bounce_detectedmessage.createdmessage.created.truncatedmessage.created.cleanedmessage.updatedmessage.updated.truncatedcontact.updatedcontact.deletedfolder.createdfolder.updatedfolder.deletedmessage.openedmessage.link_clickedthread.replied

Responses

dataobject

request_idstring

The ID for each request.

curl --request POST \ --url 'https://api.us.nylas.com/v3/webhooks/mock-payload' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <NYLAS_API_KEY>' \ --data '{ "trigger_type": "calendar.created", "webhook_url": "<WEBHOOK_URL>" }'