summaryrefslogtreecommitdiff
path: root/doc/sendgrid.markdown
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-08-29 20:00:53 -0400
committerFrederic Guillot <fred@kanboard.net>2015-08-29 20:00:53 -0400
commit6c711f696f73bc59813f6834ec241aef3b626cbd (patch)
treeded4f0e8c7f8c672414ff3f2f84eac0f6d9073e5 /doc/sendgrid.markdown
parentef087f5e22df1a0d97babef26aaf9b8960ee6d5d (diff)
Include documentation in the application
Diffstat (limited to 'doc/sendgrid.markdown')
-rw-r--r--doc/sendgrid.markdown24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/sendgrid.markdown b/doc/sendgrid.markdown
new file mode 100644
index 00000000..0f307dac
--- /dev/null
+++ b/doc/sendgrid.markdown
@@ -0,0 +1,24 @@
+Sendgrid
+========
+
+You can use the service [Sendgrid](https://sendgrid.com/) to create tasks directly by email.
+
+This integration works with the [Parse API of Sendgrid](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).
+Kanboard use a webhook to handle incoming emails.
+
+The [incoming email workflow is described here](create-tasks-by-email.markdown).
+
+Sendgrid configuration
+----------------------
+
+1. Create a new domain or subdomain (by example **inbound.mydomain.tld**) with a MX record that point to **mx.sendgrid.net**
+2. Add your domain and the Kanboard webhook url to [the configuration page in Sendgrid](https://sendgrid.com/developer/reply)
+
+The Kanboard webhook url is displayed in **Settings > Integrations > Sendgrid**
+
+Kanboard configuration
+----------------------
+
+1. Be sure that your users have an email address in their profiles
+2. Assign a project identifier to the desired projects: **Project settings > Edit**
+3. Try to send an email to your project