bytechefhq / bytechefhq/bytechef

[feature] Notifications about workflow execution issues

Open
#1,132 0 comments 0 reactions 1 assignee Claimed by @matijapetanjek View on GitHub
backend ee enhancement feature-flag frontend
Dominant language
Java
Stars
1k
Forks
170
Avg merge
11h 25m
Merged PRs (30d)
115

Description

As an Administrator
I want to configure where to receive notifications about workflow execution issues
So that I can check and fix workflows that fail to execute as soon as possible.

Acceptance Criteria
Choose to send notifications via:
- [x] email
- [ ] webhook(templates for Slack, Datadog, New Relic, Sentry or manual) - EE
- [ ] SMS (future) - EE

Technical details:

1. add notification table under platform-configuration module to support both webhook and email notification types
2. move
com.bytechef.atlas.coordinator.event.listener.WebhookJobStatusApplicationEventListener
com.bytechef.atlas.coordinator.event.listener.WebhookTaskStartedApplicationEventListener
under platform-coordinator module, maybe even merge them
3. send notification for events:
TaskExecutionCompleteEvent
TaskExecution:
CREATED, STARTED, COMPLETED, FAILED, CANCELLED
Job:
CREATED, STARTED, COMPLETED, FAILED, STOPPED
4. two notification types:
Webhook:

Form fields:
1. Events:
• ....
2. Type:
• Webhook type: Webhook.
3. URL:
• Description: Input field for the endpoint URL to which POST requests will be sent.
• Placeholder value: https://example.com/ingest.
4. Request Payload:
• Payload template: {{$.event}}.
• Description: Allows selection of properties from the alert data to be used in the payload.
5. Request Headers:
• Empty fields for headers: Key-Value pairs can be added to include headers for the outgoing HTTP requests.
6. Buttons: Options to “Test Webhook” and “Save” the configuration.

Email:

Form fields:
1. Events:
• ....
2. Type:
• Selected Type: Email.
3. To:
• Description: Input field for specifying the email address to receive alerts.
• Placeholder value: example@tasklab.com.
4. Buttons:
• Test Email: Option to test the email configuration.
• Save: Option to save the configured event destination.

Definition of Done
TODO

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.