Skip to content

zapier/zapier-platform-example-app-microsoft-exchange

Repository files navigation

Microsoft Exchange

Build Status code style: prettier

This is an example CLI App for the Zapier Developer Platform. It uses the Microsoft Exchange API, showing what a fully-featured integration looks like. It follows the best practices for building an app that we follow here at Zapier.

What it demonstrates:

  • Polling Trigger
  • Search action
  • Basic action
  • Dynamic dropdowns
  • Middleware (examples of sensible error-handling)
  • OAuth2

About the Zapier Platform

Zapier is an app automation platform where over 2 million people connect apps into customized workflows—what we call Zaps. A Zapier integration can connect your app’s API to the Zapier platform and let it integrate with 1,300+ other popular apps to watch for new or updated data, find existing data, or create and update data.

A Zapier integration for your app lets your users build workflows like that and more with your app.

If you're new to building Zapier integrations, here are some resources to get you started:

Developing

Built With

  • Node 8.10.0 (This matches with the AWS Lamba Node Verison)
  • Chai

Prerequisites

You'll need to have the Zapier Platform CLI installed if you haven't already:

npm install -g zapier-platform-cli

Setting up Dev

Run the following commands to get started locally:

git clone git@github.com:zapier/zapier-platform-cli-apps.git
cd zapier-platform-cli-apps/apps/microsoft-exchange
npm install

Run zapier register 'My Example MS Exchange App' to register the app with Zapier.

You'll need to register a new app in Microsoft Azure, which you can do here: https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade

The app will have a Client ID and Client Secret, which you can set by following the instructions here: https://platform.zapier.com/cli_docs/docs#defining-environment-variables

Versioning

We should use SemVer for versioning. For the versions available, see the CHANGELOG.

Tests

Right now all we have are unit tests. You can run them with the command zapier test.

Style guide

We use ESLint and a common set of rules developed by AirBnB with a couple of tweaks. Linting should occur automatically whenever you make a commit (see package.json for the exact things being run).

With that being said, you can run the following command to run the lint check against all of your files:

npm run lint

Or you can run this to format all of your files properly:

npm run format

Api References

https://docs.microsoft.com/en-us/graph/use-the-api

Contributing

We are not accepting contributions to this repo. This is just an example integration that illustrates a more comprehensive example of a Zapier integration built using the Zapier CLI.

This repo isn't actively maintained.

About

An example Zapier CLI app for MS Exchange

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published