diff --git a/apps/docs/content/docs/en/execution/api.mdx b/apps/docs/content/docs/en/execution/api.mdx index ba378a8bc74..37fda5f1422 100644 --- a/apps/docs/content/docs/en/execution/api.mdx +++ b/apps/docs/content/docs/en/execution/api.mdx @@ -240,32 +240,78 @@ Retrieve execution details including the workflow state snapshot. -## Webhook Subscriptions +## Notifications -Get real-time notifications when workflow executions complete. Webhooks are configured through the Sim UI in the workflow editor. +Get real-time notifications when workflow executions complete via webhook, email, or Slack. Notifications are configured at the workspace level from the Logs page. ### Configuration -Webhooks can be configured for each workflow through the workflow editor UI. Click the webhook icon in the control bar to set up your webhook subscriptions. +Configure notifications from the Logs page by clicking the menu button and selecting "Configure Notifications". -
This is a test notification from Sim Studio.
+| Workflow | ${data.workflowName} |
| Status | ${data.status} |
| Duration | ${data.totalDurationMs}ms |
This notification is configured for workspace notifications.
+
+ {identifier}
+
+ + {editingId ? 'Edit Notification' : 'Create New Notification'} +
++ Configure {activeTab} notifications for workflow executions +
+{formErrors.general}
++ {formData.useAlertRule + ? 'Notify when failure patterns are detected' + : 'Notify on every matching execution'} +
++ {ALERT_RULES.find((r) => r.value === formData.alertRule)?.description} +
+{formErrors.consecutiveFailures}
+ )} +{formErrors.failureRatePercent}
+ )} +{formErrors.windowHours}
+ )} +{formErrors.durationThresholdMs}
+ )} +{formErrors.latencySpikePercent}
+ )} +{formErrors.windowHours}
+ )} +{formErrors.costThresholdDollars}
+ )} +{formErrors.inactivityHours}
+ )} +{formErrors.errorCountThreshold}
+ )} +{formErrors.windowHours}
+ )} +{formErrors.webhookUrl}
+ )} ++ Used to sign webhook payloads with HMAC-SHA256 +
++ Comma-separated list of email addresses (max 10) +
+ {formErrors.emailRecipients && ( +{formErrors.emailRecipients}
+ )} ++ No Slack accounts connected +
+{formErrors.slackAccountId}
+ )} ++ Select which log levels trigger notifications +
+{formErrors.levelFilter}
+ )} ++ Select which trigger types send notifications +
+{formErrors.triggerFilter}
+ )} ++ Additional data to include in notifications +
++ No {activeTab} notifications configured +
+Select a Slack account first
++ {selectedChannel.isPrivate ? 'Private' : 'Public'} channel: #{selectedChannel.name} +
+ )} + {error &&{error}
} ++ Select which workflows should trigger this notification +
+${escapedJson}
+ + © ${new Date().getFullYear()} Sim Studio, All Rights Reserved +
++ Privacy Policy • + Terms of Service +
+