diff --git a/apps/docs/examples/examples.mdx b/apps/docs/examples/examples.mdx
index c8196f5e109..e1addc36d8c 100644
--- a/apps/docs/examples/examples.mdx
+++ b/apps/docs/examples/examples.mdx
@@ -17,5 +17,7 @@ You can use these workflows in your product by following the instructions on eac
Post to Slack when a GitHub issue is created or modified.
-
+
+ Create a welcome email drip campaign.
+
diff --git a/apps/docs/examples/resend.mdx b/apps/docs/examples/resend.mdx
index 8e3d744d306..36ce42ac255 100644
--- a/apps/docs/examples/resend.mdx
+++ b/apps/docs/examples/resend.mdx
@@ -4,6 +4,11 @@ sidebarTitle: "Resend"
description: "Here are some example workflows you could create using the Resend integration."
---
+
+ Resend is in private beta, if you would like access please contact us at{" "}
+ help@trigger.dev
+
+
## Welcome email drip campaign
This workflow will get triggered and a Slack notification and welcom email will be sent straight away.
diff --git a/apps/docs/functions/send-event.mdx b/apps/docs/functions/send-event.mdx
index b709fcaaae7..9c11909a576 100644
--- a/apps/docs/functions/send-event.mdx
+++ b/apps/docs/functions/send-event.mdx
@@ -4,9 +4,12 @@ sidebarTitle: "Send event"
description: "Send events to trigger your custom events workflows."
---
-## How to send an event
+## Send an event
-You can send an event from anywhere in your code, including from inside another workflow.
+You can easily send an event from anywhere, including from inside another workflow. Events don't have to come from the same server as your workflow and can be sent as HTTP requests from any language (see our cURL example below for the format).
+
+
+
```ts
import { sendEvent } from "@trigger.dev/sdk";
@@ -19,12 +22,180 @@ await sendEvent("start-fire-2", {
});
```
+
+
+
+```bash
+curl --request POST \
+ --url https://app.trigger.dev/api/v1/events \
+ --header 'Authorization: Bearer ' \
+ --header 'Content-Type: application/json' \
+ --data '{
+ "id": "",
+ "event": {
+ "name": "user.created",
+ "payload": {
+ "userId": "123456"
+ }
+ }
+ }'
+```
+
+
+
+
If you are calling this from inside a workflow, ensure that the first parameter is unique inside your workflow.
## Sending events from other workflows
-It is useful to send events from workflows because you can split your logic into smaller chunks and reuse them.
+It is useful to send events from workflows because you can split your logic into smaller chunks and reuse them. The below example shows how a scheduled workflow delegates the work via sending a custom event:
+
+
+
+```ts check-scheduler.ts
+new Trigger({
+ id: "check-scheduler",
+ name: "Check Scheduler",
+ on: scheduleEvent({ rateOf: { minutes: 10 } }),
+ run: async (event, context) => {
+ await context.sendEvent("health.check trigger.dev", {
+ name: "health.check",
+ payload: {
+ url: "https://trigger.dev",
+ host: "trigger.dev",
+ },
+ });
+
+ await context.sendEvent("health.check docs.trigger.dev", {
+ name: "health.check",
+ payload: {
+ url: "https://docs.trigger.dev",
+ host: "docs.trigger.dev",
+ },
+ });
+
+ await context.sendEvent("health.check app.trigger.dev", {
+ name: "health.check",
+ payload: {
+ url: "https://app.trigger.dev/healthcheck",
+ host: "app.trigger.dev",
+ },
+ });
+ },
+}).listen();
+```
+
+```ts health-check.ts
+export const healthCheck = new Trigger({
+ id: "health-check",
+ name: "Health Check",
+ on: customEvent({
+ name: "health.check",
+ schema: z.object({
+ url: z.string().url(),
+ host: z.string(),
+ }),
+ }),
+ run: async (event, context) => {
+ const response = await context.fetch("fetch site", event.url, {
+ method: "GET",
+ retry: {
+ enabled: false,
+ },
+ });
+
+ if (response.ok) {
+ await context.logger.info(`${event.host} is up!`);
+ return;
+ }
+
+ await slack.postMessage("Site is down", {
+ channelName: "health-checks",
+ text: `${event.host} is down: ${response.status}`,
+ });
+ },
+}).listen();
+```
+
+
+
+## Delaying event delivery
-## Writing a workflow that is triggered by an event
+Through both our Node.js SDK and our HTTP API, you can delay the delivery of an event. This is useful if you want to send an event to trigger a workflow, but you want to wait for a certain amount of time before the event is delivered.
-You should read [the documentation on custom events](/triggers/custom-events) to learn how to write a workflow that is triggered by an event.
+Using the health check example above, we can delay the delivery of the `health.check` event in various ways:
+
+```ts
+new Trigger({
+ id: "check-scheduler",
+ name: "Check Scheduler",
+ on: scheduleEvent({ rateOf: { minutes: 10 } }),
+ run: async (event, context) => {
+ await context.sendEvent("health.check trigger.dev", {
+ name: "health.check",
+ payload: {
+ url: "https://trigger.dev",
+ host: "trigger.dev",
+ },
+ delay: { until: new Date(Date.now() + 1000 * 60 * 5) }, // Delay until a specific date
+ });
+
+ await context.sendEvent("health.check docs.trigger.dev", {
+ name: "health.check",
+ payload: {
+ url: "https://docs.trigger.dev",
+ host: "docs.trigger.dev",
+ },
+ delay: { minutes: 5 }, // Delay for a specific amount of time
+ });
+
+ await context.sendEvent("health.check app.trigger.dev", {
+ name: "health.check",
+ payload: {
+ url: "https://app.trigger.dev/healthcheck",
+ host: "app.trigger.dev",
+ },
+ delay: { seconds: 30 }, // Delay for a specific amount of time
+ });
+ },
+}).listen();
+```
+
+
+ When sending events in the context of a workflow run, adding a delay DOES NOT
+ add a delay to the workflow run, as sending a custom event is a
+ fire-and-forget action.
+
+
+You can add delays via the HTTP API by adding a `delay` object to the event:
+
+```bash
+curl --request POST \
+ --url https://app.trigger.dev/api/v1/events \
+ --header 'Authorization: Bearer ' \
+ --header 'Content-Type: application/json' \
+ --data '{
+ "id": "",
+ "event": {
+ "name": "user.created",
+ "payload": {
+ "userId": "123456"
+ },
+ "delay": {
+ "seconds": 30
+ }
+ }
+ }'
+```
+
+## Event deduplication
+
+When sending events, you can specify an `id` for the event. If you send an event with the same `id` multiple times, only the first event will be delivered. This is useful if you want to ensure that an event is only delivered once, even if you send it multiple times.
+
+```ts
+sendEvent({
+ id: "my-event-id",
+ name: "my-event",
+ payload: { foo: "bar" },
+});
+```
diff --git a/apps/docs/integrations/apis/slack/actions/post-message.mdx b/apps/docs/integrations/apis/slack/actions/post-message.mdx
index e1e9585a583..e2689e35f05 100644
--- a/apps/docs/integrations/apis/slack/actions/post-message.mdx
+++ b/apps/docs/integrations/apis/slack/actions/post-message.mdx
@@ -28,6 +28,14 @@ Publish slack messages to a public or private channel in your Slack Workspace as
The formatted text of the message to be published, formatted as [mrkdwn](https://api.slack.com/reference/surfaces/formatting#basics).
+
+ You can use blocks to create a rich message with images, buttons, and more.
+
+ You can either pass in a JavaScript object or use [JSX Slack](https://github.com/yhatt/jsx-slack/) to create blocks. We highly recommend using JSX Slack, it's much easier to read and write. See the [block example](#) to see it in action.
+
+ Full full detail on block see the [Slack API docs](https://api.slack.com/reference/block-kit/blocks).
+
+
@@ -69,6 +77,8 @@ Publish slack messages to a public or private channel in your Slack Workspace as
## Example Workflows
+### Notify Slack on New Star
+
```typescript Notify Slack on New Star
@@ -89,11 +99,7 @@ new Trigger({
}).listen();
```
-
-
-## Example Response
-
-```json
+```json Example response
{
"ok": true,
"ts": "1673618429.084699",
@@ -107,3 +113,135 @@ new Trigger({
}
}
```
+
+
+
+### Blocks with interactivity
+
+You can add interaction and richer visual elements using Blocks. The easiest way to add them is using `jsx-slack` (which is a separate npm package that you can install).
+
+This example messages your team every minute (!) and asks them how they're doing. There are two buttons and a dropdown menu.
+
+In this examples there are two workflows:
+
+1. Messages your team every minute (!) and asks them how they're doing.
+2. Receives the interaction from users. It adds reactions when the buttons are pressed and posts a message when a user selects from the dropdown menu.
+
+
+
+```typescript Blocks with interactivity
+import { slack } from "@trigger.dev/integrations";
+import JSXSlack, {
+ Actions,
+ Blocks,
+ Button,
+ Section,
+ Select,
+ Option,
+} from "jsx-slack";
+import { z } from "zod";
+
+const BLOCK_ID = "issue.action.block";
+
+//1. every minute see how your employees are doing, we don't recommend this frequency 😉
+new Trigger({
+ id: "slack-interactivity",
+ name: "Testing Slack Interactivity",
+ on: scheduleEvent({
+ rateOf: {
+ minutes: 1,
+ },
+ }),
+ run: async (event, ctx) => {
+ await slack.postMessage("jsx-test", {
+ channelName: "test-integrations",
+ //text appears in Slack notifications on mobile/desktop
+ text: "How is your progress today?",
+ //import and use JSXSlack to make creating rich messages much easier
+ blocks: JSXSlack(
+
+ How is your progress today?
+
+
+
+
+
+
+ ),
+ });
+ },
+}).listen();
+
+//2. this workflow listens for Slack interactions filtered by the block id and actions we used above
+new Trigger({
+ id: "slack-block-interaction",
+ name: "Slack Block Interaction",
+ on: slack.events.blockActionInteraction({
+ blockId: BLOCK_ID,
+ actionId: ["status-blocked", "status-help", "rating"],
+ }),
+ run: async (event, ctx) => {
+ //create promises from all the actions
+ const promises = event.actions.map((action) => {
+ switch (action.action_id) {
+ case "status-blocked": {
+ //the user is blocked so add a 😢 emoji as a reaction
+ if (event.message) {
+ return slack.addReaction("React to message", {
+ name: "cry",
+ timestamp: event.message.ts,
+ channelId: event.channel.id,
+ });
+ }
+ }
+ case "status-help": {
+ //the user needs help so add an 🆘 emoji as a reaction
+ if (event.message) {
+ return slack.addReaction("React to message", {
+ name: "sos",
+ timestamp: event.message.ts,
+ channelId: event.channel.id,
+ });
+ }
+ }
+ case "rating": {
+ if (action.type != "static_select") {
+ throw new Error("This action should be a select");
+ }
+
+ //post the rating as a message that appears below the original,
+ //only the user pressing the button will see this message
+ return slack.postMessageResponse(
+ "Added a comment to the issue",
+ event.response_url,
+ {
+ text: `You rated your day ${action.selected_option?.value} stars`,
+ replace_original: false,
+ }
+ );
+ }
+ default:
+ return Promise.resolve();
+ }
+ });
+
+ await Promise.all(promises);
+ },
+}).listen();
+```
+
+
diff --git a/apps/docs/mint.json b/apps/docs/mint.json
index 41e403a370c..77f128cced6 100644
--- a/apps/docs/mint.json
+++ b/apps/docs/mint.json
@@ -3,7 +3,7 @@
"logo": {
"dark": "/logo/light.png",
"light": "/logo/light.png",
- "href": "https://trigger.dev"
+ "href": "https://app.trigger.dev"
},
"favicon": "/images/favicon.png",
"colors": {
@@ -20,6 +20,16 @@
"default": "dark",
"isHidden": true
},
+ "topbarLinks": [
+ {
+ "name": "Login",
+ "url": "https://app.trigger.dev"
+ },
+ {
+ "name": "Sign up",
+ "url": "https://app.trigger.dev"
+ }
+ ],
"topbarCtaButton": {
"type": "github",
"url": "https://github.com/triggerdotdev/trigger.dev"
@@ -39,11 +49,7 @@
"navigation": [
{
"group": "Getting Started",
- "pages": [
- "welcome",
- "getting-started",
- "get-help"
- ]
+ "pages": ["welcome", "getting-started", "get-help"]
},
{
"group": "Examples",
@@ -71,15 +77,11 @@
"pages": [
{
"group": "Slack",
- "pages": [
- "integrations/apis/slack/actions/post-message"
- ]
+ "pages": ["integrations/apis/slack/actions/post-message"]
},
{
"group": "Resend.com",
- "pages": [
- "integrations/apis/resend/actions/send-email"
- ]
+ "pages": ["integrations/apis/resend/actions/send-email"]
}
]
},
@@ -111,7 +113,8 @@
"reference/trigger",
"reference/custom-event",
"reference/webhook-event",
- "reference/schedule-event"
+ "reference/schedule-event",
+ "reference/send-event"
]
},
{
@@ -137,4 +140,4 @@
"github": "https://github.com/triggerdotdev/trigger.dev",
"discord": "https://discord.gg/nkqV9xBYWy"
}
-}
\ No newline at end of file
+}
diff --git a/apps/docs/reference/send-event.mdx b/apps/docs/reference/send-event.mdx
new file mode 100644
index 00000000000..06c931d9f0f
--- /dev/null
+++ b/apps/docs/reference/send-event.mdx
@@ -0,0 +1,97 @@
+---
+title: "sendEvent"
+sidebarTitle: "sendEvent"
+description: "Send a custom event to Trigger, from inside or outside of a workflow."
+---
+
+## Usage
+
+```ts
+import { Trigger, customEvent } from "@trigger.dev/sdk";
+
+new Trigger({
+ id: "usage",
+ name: "usage",
+ on: customEvent({
+ name: "user.created",
+ schema: z.any(),
+ }),
+ run: async (event, ctx) => {
+ await ctx.sendEvent("Sending context user.created event", {
+ name: "user.created",
+ payload: {
+ id: "1234_abc",
+ },
+ });
+ },
+}).listen();
+```
+
+You can also use `sendEvent` by importing it from `@trigger.dev/sdk`:
+
+```ts
+import { sendEvent } from "@trigger.dev/sdk";
+
+await sendEvent("Sending context user.created event", {
+ name: "user.created",
+ payload: {
+ id: "1234_abc",
+ },
+});
+```
+
+
+ If calling `sendEvent` from outside of a workflow run, it will make an HTTP
+ API request to app.trigger.dev to send the event. Make sure you set the
+ `TRIGGER_API_KEY` environment variable if you will be using it this way.
+
+
+## Parameters
+
+
+ A unique key for the event in the context of a workflow run. Please see the
+ [Keys and Resumability](/guides/resumability) guide for more info.
+
+
+
+
+
+ An optional unique ID for the event. If not provided, one will be
+ generated automatically (using `clid`). Set this field to perform event
+ deduplication.
+
+
+
+ The name of the event. This is the name you set when creating the
+ `customEvent` trigger.
+
+
+
+ The payload of the event.
+
+
+
+ An optional timestamp for the event. If not provided, one will be generated. Must be in ISO 8601 format (e.g. `new Date().toISOString()`)
+
+
+
+ An optional context object for the event. This can be used to pass
+ additional information about the event, such as the user who triggered
+ it. Note that this is not currently exposed to the workflow (coming soon).
+
+
+
+ An optional delay object for the event. This can be used to delay the
+ event by a certain amount of time. Use one of the following options:
+
+ - `{ seconds: number }` - delay the event by a certain number of seconds
+ - `{ minutes: number }` - delay the event by a certain number of minutes
+ - `{ hours: number }` - delay the event by a certain number of hours
+ - `{ days: number }` - delay the event by a certain number of days
+ - `{ until: Date }` - delay the event until a certain date
+
+ See the [Delaying Event Delivery](/functions/send-event#delaying-event-delivery) docs for more info.
+
+
+
+
diff --git a/apps/docs/welcome.mdx b/apps/docs/welcome.mdx
index 98c6b3043e9..c723b28780f 100644
--- a/apps/docs/welcome.mdx
+++ b/apps/docs/welcome.mdx
@@ -8,19 +8,21 @@ Trigger.dev is an open source platform that enables developers to create event-d
Workflows live in your codebase so you can use your existing types, functions, version control and IDE. They are triggered by us but run on your server so your private data is never exposed.
+Go to [trigger.dev](https://app.trigger.dev) and sign up or login to your account.
+
_A workflow in action:_
-
+
Quickly get up and running with Trigger.dev by following our quick start
diff --git a/apps/webapp/app/assets/images/triggers/slack-interaction.png b/apps/webapp/app/assets/images/triggers/slack-interaction.png
new file mode 100644
index 00000000000..9ea87cfe05e
Binary files /dev/null and b/apps/webapp/app/assets/images/triggers/slack-interaction.png differ
diff --git a/apps/webapp/app/components/CreateNewWorkflow.tsx b/apps/webapp/app/components/CreateNewWorkflow.tsx
index 92961e3930b..591f8337cea 100644
--- a/apps/webapp/app/components/CreateNewWorkflow.tsx
+++ b/apps/webapp/app/components/CreateNewWorkflow.tsx
@@ -62,7 +62,7 @@ export function CreateNewWorkflowNoWorkflows() {
@@ -84,14 +84,22 @@ export function CreateNewWorkflowNoWorkflows() {
Easily authenticate with APIs using the supported integrations
below. If there's an integration we don't yet support,{" "}
-
+ {" "}
+ vote for it here
+ {" "}
and we'll add it.
+