Docs/sendgrid doc (#359)

* added sengrid integration to the catalog

* added documention for sendgrid integration

* updated the mint.json file

Author: Chigala

apps/webapp/app/services/externalApis/integrationCatalog.server.ts

@@ -4,6 +4,7 @@ import { plain } from "./integrations/plain";
 import { resend } from "./integrations/resend";
 import { slack } from "./integrations/slack";
 import { stripe } from "./integrations/stripe";
+import { sendgrid } from "./integrations/sendgrid";
 import { supabaseManagement, supabase } from "./integrations/supabase";
 import { typeform } from "./integrations/typeform";
 import type { Integration } from "./types";
@@ -34,8 +35,9 @@ export const integrationCatalog = new IntegrationCatalog({
   plain,
   resend,
   slack,
-  typeform,
   stripe,
   supabaseManagement,
   supabase,
+  sendgrid,
+  typeform,
 });

apps/webapp/app/services/externalApis/integrations/sendgrid.ts

@@ -0,0 +1,60 @@
+import type { Integration } from "../types";
+
+export const sendgrid: Integration = {
+  identifier: "sendgrid",
+  name: "SendGrid",
+  packageName: "@trigger.dev/sendgrid@latest",
+  authenticationMethods: {
+    apikey: {
+      type: "apikey",
+      help: {
+        samples: [
+          {
+            title: "Creating the client",
+            code: `
+import { SendGrid } from "@trigger.dev/sendgrid";
+
+const sendgrid = new SendGrid({
+  id: "__SLUG__",
+  apiKey: process.env.SENDGRID_API_KEY!,
+});
+`,
+          },
+          {
+            title: "Using the client",
+            code: `
+client.defineJob({
+  id: "send-sendgrid-email",
+  name: "Send SendGrid Email",
+  version: "0.1.0",
+  trigger: eventTrigger({
+    name: "send.email",
+    schema: z.object({
+      to: z.string(),
+      subject: z.string(),
+      text: z.string(),
+    }),
+  }),
+  integrations: {
+    sendgrid,
+  },
+  run: async (payload, io, ctx) => {
+    await io.sendgrid.sendEmail({
+      to: payload.to,
+      from: "Trigger.dev <[email protected]>",
+      subject: payload.subject,
+      text: payload.text,
+    });
+  },
+});
+            `,
+            highlight: [
+              [13, 15],
+              [17, 22],
+            ],
+          },
+        ],
+      },
+    },
+  },
+};

docs/integrations/apis/sendgrid.mdx

@@ -0,0 +1,86 @@
+---
+title: Introduction
+---
+
+<Snippet file="integration-getting-started.mdx" />
+
+## Installation
+
+<CodeGroup>
+
+```bash npm
+npm install @trigger.dev/sendgrid@latest
+```
+
+```bash pnpm
+pnpm install @trigger.dev/sendgrid@latest
+```
+
+```bash yarn
+yarn add @trigger.dev/sendgrid@latest
+```
+
+</CodeGroup>
+
+## Authentication
+
+ SendGrid integration supports API Keys. To authenticate, you'll need to create an instance of the SendGrid class and provide your API key.
+
+```ts
+import { SendGrid } from "@trigger.dev/sendgrid";
+
+const sendgrid = new SendGrid({
+  id: "sendgrid",
+  apiKey: process.env.SENDGRID_API_KEY!,
+});
+
+```
+
+## Example
+
+In this example we use [Zod](/documentation/guides/zod), a TypeScript-first schema declaration and validation library.
+
+```ts
+import { SendGrid } from "@trigger.dev/sendgrid";
+import { Job, eventTrigger } from "@trigger.dev/sdk";
+import { z } from "zod";
+
+// Create an instance of SendGrid
+const sendgrid = new SendGrid({
+  id: "sendgrid",
+  apiKey: process.env.SENDGRID_API_KEY!,
+});
+
+// Define a Trigger.dev job
+client.defineJob({
+  id: "send-sendgrid-email",
+  name: "Send SendGrid Email",
+  version: "0.1.0",
+  trigger: eventTrigger({
+    name: "send.email",
+    schema: z.object({
+      to:z.string(),
+      subject: z.string(),
+      text: z.string(),
+    }),
+  }),
+  integrations: {
+    sendgrid,
+  },
+  run: async (payload, io, ctx) => {
+    await io.sendgrid.sendEmail({
+      to: payload.to,
+      from: "Trigger.dev <[email protected]>",
+      subject: payload.subject,
+      text: payload.text,
+    });
+  },
+});
+
+```
+
+## Tasks
+
+| Function Name | Description   |
+| ------------- | ------------- |
+| `sendEmail`   | Send an email |

docs/mint.json

@@ -213,7 +213,13 @@
             "integrations/apis/slack"
           ]
         },
-        "integrations/apis/typeform"
+        "integrations/apis/typeform", 
+        {
+          "group": "Sendgrid", 
+          "pages": [
+            "integrations/apis/sendgrid"
+          ]
+        }
       ]
     },
     {