---
title: "Get mock notification payload"
method: POST
path: "/v3/webhooks/mock-payload"
tags: ["Webhook Notifications", "Pub/Sub Notifications"]
---

# Get mock notification payload

`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.

## Request body

- GetMockPayloadInput
  - `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](/docs/reference/notifications/) for details about each trigger type. See the [Grants](/docs/reference/api/manage-grants/), [Calendar](/docs/reference/api/calendar/), [Events](/docs/reference/api/events/), and [Messages](/docs/reference/api/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](/docs/v3/notifications/#truncated-webhooks).

## Response `200`

Webhook Payload Returned

- object
  - `data` object
    - `data` object — This object is an example payload that Nylas sends to your webhook destination
  - `request_id` string — The ID for each request.

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.dev/nylas/apis/nylas-api.md) · [All operations](https://skmtc.dev/nylas/apis/nylas-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nylas/nylas-api/revisions/51c2c1b4ecff/schema)