Sign in
Webhook Notifications

Send test event

Use this endpoint to check if your project's webhook destination is configured correctly. Nylas sends a test webhook payload to the webhook URL you specify, and listens for a success acknowledgement.

The secret used is mock-webhook-secret.

post/v3/webhooks/send-test-event

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

Select the type of event that will trigger the webhook. 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.

webhook_urlstring required

The URL to send webhooks to.

Example request

{
  "webhook_url": "https://example.com/webhooks"
}

Response

Test event sent

datastring

Indicates if the test event succeeded or failed.

request_idstring

The ID for each request.

Example response

{
  "data": "success"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.