Sign in
Webhook Notifications

Rotate a webhook secret

Update the webhook secret value for a destination. The previous value will immediately stop being used and the new value will take over.

Webhook notification header

Every webhook notification Nylas sends includes the x-nylas-signature header. Depending on the SDK you're using, you might see X-Nylas-Signature instead.

post/v3/webhooks/rotate-secret/{id}

Path parameters

idstring required

Response

Webhook Secret Updated

request_idstring

The request ID for each request.

Example response

{
  "data": {
    "id": "UMWjAjMeWQ4D8gYF2moonK4486",
    "description": "Production webhook destination",
    "webhook_url": "https://example.com/webhooks",
    "webhook_secret": "41dD3-nXTUfebYuk81Gr",
    "notification_email_addresses": [
      "jane@example.com",
      "joe@example.com"
    ]
  }
}

Changes

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