Only show these results:

Omni Channel Event Reminders

You can notify participants of events in multiple ways.

  • Gmail, Microsoft, and Google support calendar popups. See our Events API for an example.
  • Nylas can send email, SMS, and webhook (Slack, Teams, etc.) reminders to participants.

Paid Feature

SMS notifications is a paid feature. Please reach out to your account manager for access.

Scopes

email.send scope required.

Webhook Notifications

Webhook notifications can send a payload to any URL. Use webhooks to send notifications to providers such as Slack and Teams.

curl --request POST \
  --url https://api.nylas.com/events \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <NYLAS_ACCESS_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "Lets celebrate",
  "location": "Roller Rink",
  "calendar_id": "egtdopqam5jxky7ifrkwcra55",
  "busy": true,
  "read_only": false,
  "conferencing": {
    "provider": "Zoom Meeting",
    "autocreate": {
      "settings": {
        "settings": {}
      }
    }
  },
  "participants": [
    {
      "name": "Katherine Johnson",
      "email": "[email protected]",
      "phone_number": "+12223456789"
    }
  ],
  "when": {
    "start_time": "1627499520",
    "end_time": "1630245600"
  },
  "notifications": [
    {
        "type": "webhook",
        "minutes_before_event": "60",
        "url": "https://hooks.service.com/services/T01A03EEXDE/B01TBNH532R/HubIZu1zog4oYdFqQ8VUcuiW",
        "payload": "{\"text\" : \"Your reminder goes here!\"}"
    }
  ]
}'

Email Notifications

Message Tracking

Message tracking is not supported for email notifications.

curl --location --request POST 'https://api.nylas.com/events' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <NYLAS_ACCESS_TOKEN>' \
--data-raw '{
    "title": "hello Again",
    "location": "Roller Rink",
    "calendar_id": "egtdopqam5jxky7ifrkwcra55",
    "busy": true,
    "read_only": false,
    "conferencing":{
      "provider": "Zoom Meeting",
      "autocreate":{
          "settings":{
              "password": "6789011",
              "settings":{
                  "mute_upon_entry": true
              }

          }
      },
        "details": {
            "meeting_code": "string",
            "password": "string",
            "url": "string"
        }
    },
    "participants": [
         {
            "name": "Katherine Johnson",
            "email": "[email protected]",
            "phone_number": "+12223456789"
          }
      ],
    "description": "Lets celebrate",
    "when": {
        "start_time": "1627499520",
        "end_time": "1630245600"
    },

       "notifications": [
            {
                "type": "email",
                "minutes_before_event": "600", // in minutes
                "subject": "Test Event Notification",
                "body": "Reminding you about our meeting." //Accepts HTML
            }
       ]
}'

SMS Notifications 

curl --location --request POST 'https://api.nylas.com/events' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <NYLAS_ACCESS_TOKEN>' \
--data-raw '{
    "title": "hello Again",
    "location": "Roller Rink",
    "calendar_id": "egtdopqam5jxky7ifrkwcra55",
    "busy": true,
    "read_only": false,
    "conferencing":{
      "provider": "Zoom Meeting",
      "autocreate":{
          "settings":{
              "password": "6789011",
              "settings":{
                  "mute_upon_entry": true
              }

          }
      },
        "details": {
            "meeting_code": "string",
            "password": "string",
            "url": "string"
        }
    },
    "participants": [
         {
            "name": "Katherine Johnson",
            "email": "[email protected]",
            "phone_number": "+12223456789"
          }
      ],
    "description": "Lets celebrate",
    "when": {
        "start_time": "1627499520",
        "end_time": "1630245600"
    },

       "notifications": [
            {
                "type": "sms",
                "minutes_before_event": "60",
                "message": "Test Event Notfication"
            }
       ]
}'

Multiple Notifications

You can add multiple notifications with different types for each event. Participants must have an email and phone number attached.

curl --location --request POST 'https://api.nylas.com/events' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <NYLAS_ACCESS_TOKEN>' \
--data-raw '{
    "title": "hello Again",
    "location": "Roller Rink",
    "calendar_id": "egtdopqam5jxky7ifrkwcra55",
    "busy": true,
    "read_only": false,
    "conferencing":{
      "provider": "Zoom Meeting",
      "autocreate":{
          "settings":{
              "password": "6789011",
              "settings":{
                  "mute_upon_entry": true
              }

          }
      },
        "details": {
            "meeting_code": "string",
            "password": "string",
            "url": "string"
        }
    },
    "participants": [
         {
            "name": "Katherine Johnson",
            "email": "[email protected]",
            "phone_number": "+12223456789"
          }
      ],
    "description": "Lets celebrate",
    "when": {
        "start_time": "1627499520",
        "end_time": "1630245600"
    },

       "notifications": [
            {
                "type": "email",
                "minutes_before_event": "600", // in minutes
                "subject": "Test Event Notification",
                "body": "Reminding you about our meeting." //Accepts HTML
            },
            {
                "type": "sms",
                "minutes_before_event": "60",
                "message": "Test Event Notfication"
            }
       ]
}'

Delete Notifications

To remove notifications from an event, send an empty notifications array as a PUT request.

curl --location --request POST 'https://api.nylas.com/events/<EVENT_ID>' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <NYLAS_ACCESS_TOKEN>' \
--data-raw '{
    "title": "hello Again",
    "location": "Roller Rink",
    "calendar_id": "egtdopqam5jxky7ifrkwcra55",
    "busy": true,
    "read_only": false,
    "conferencing":{
      "provider": "Zoom Meeting",
      "autocreate":{
          "settings":{
              "password": "6789011",
              "settings":{
                  "mute_upon_entry": true
              }

          }
      },
        "details": {
            "meeting_code": "string",
            "password": "string",
            "url": "string"
        }
    },
    "participants": [
         {
            "name": "Katherine Johnson",
            "email": "[email protected]",
            "phone_number": "+12223456789"
          }
      ],
    "description": "Lets celebrate",
    "when": {
        "start_time": "1627499520",
        "end_time": "1630245600"
    },

       "notifications": []
}'

Notification Limitations

  • You cannot update a recurring event to use notifications.
  • Notifications are only sent for the main event.
  • Notifications created five minutes before the event may not send. These tend to fail silently. We recommend creating the reminders ahead of time to prevent failures.

What's Next?