Nylas Docs

The Nylas Developer Hub

Welcome to the Nylas developer hub. You'll find comprehensive guides and documentation to help you start working with Nylas as quickly as possible, as well as support if you get stuck. Let's jump right in!

Developer Guide

Nylas Workflows

Nylas Workflows help you quickly build integrations by making it easier to work with common scenarios. Learn about Workflows

Nylas Workflows help you quickly build integrations by making it easier to work with common scenarios. For example, instead of needing to build out a separate event and reminder application, use our create event reminder workflow to combine them into one API call.

Available Workflows

Reminders

There are 3 ways to notify your users of events:

You can create multiple reminders and different types of reminders to fit your needs.

SMS Reminders

SMS reminders send out reminders to your user’s phone numbers. When adding event participants, if you want to send SMS reminders, the phone number must be added. Currently, only North American phone numbers are supported. Review the supported carriers for the most up to date information.

Supported Carriers

CountryCarrier
USAATT
USAGoogle Voice
CanadaBell
USATMobile
USATwilio Numbers

Webhook Reminders

With webhook reminders, you can integrate with any system that uses webhook URLs. If you want to use webhooks reminders for Teams or Slack, there are a few extra steps.

Teams

The Teams administrator will need to set up incoming webhooks. Once complete, add the webhook URL to the create-event-reminder template.

Slack

The Slack administrator will need to set up incoming webhooks. Once complete, add the webhook URL to the create-event-reminder template.

Email Reminders

Email reminders support file attachments and message tracking webhooks. To attach a file, first, upload the file, then reference the file ID.

To receive message tracking notifications, subscribe to the message tracking webhooks.

Workflow Status

There are 2 ways you can track your workflow status:

Webhooks - Use webhooks for event.created and message tracking.
Get Workflows - To see if the workflow is running.

Webhooks

If you want to get a notification that an event has been created subscribe to the event.created webhook. If you have added message tracking and want to get notified of message events, subscribe to the message tracking.

📘

SMS and Webhook Reminders

There are no webhooks for SMS and Webhook reminders.

Status

You can use the Get Webhook or Get Webhook by ID endpoints to see if a workflow is running or not. You must be subscribed to webhooks before you can get the workflow status.

Workflows can have the following statuses:

  • open - Workflow is running
  • closed - Workflow has stopped

Keep In Mind

  • Workflows can not be stopped or edited.
  • You can add multiple reminders using multiple methods.
  • Workflows are accessible using the Get Webhooks and Get Webhook by ID for 30 days.
  • Failed and successful webhooks will have a closed status.
  • SMS can only be sent to North American phone numbers. See Supported Carriers for more.
  • To use message tracking, you need to subscribe to message webhooks.

Updated 4 days ago


What's Next

Take a look at the Creating Your First Workflow or review the Workflow API endpoint.

Create a Workflow
Workflow Endpoints

Nylas Workflows


Nylas Workflows help you quickly build integrations by making it easier to work with common scenarios. Learn about Workflows

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.