You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/extensions.md
+35-16Lines changed: 35 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# Shuffle extensions
2
-
This is documentation for integrating and sending data from third-party services to Shuffle. Not to be confused with [apps](/apps) and [workflows](/workflows)
2
+
This is documentation for integrating and sending data from third-party services to Shuffle, along with being a brief overview of our Research & Development (R&D) activities. Not to be confused with [apps](/apps) and [workflows](/workflows)
3
3
4
4
## Table of contents
5
5
*[Introduction](#introduction)
@@ -12,9 +12,11 @@ This is documentation for integrating and sending data from third-party services
12
12
*[Azure AD - OpenID](#azure-ad)
13
13
*[Other SSO providers](#other)
14
14
*[Testing SSO](#sso-testing)
15
+
*[Singul](#singul)
16
+
*[AI Agents](#ai-agents)
17
+
*[CACAO](#cacao)
15
18
*[Detection Manager](#detection-manager)
16
19
*[KMS](#KMS)
17
-
*[Native Actions](#native-actions)
18
20
*[Webhooks](#webhooks)
19
21
*[Wazuh Webhook](#wazuh)
20
22
*[TheHive Webhook](#thehive)
@@ -290,6 +292,37 @@ Important Notes
290
292
If you have any questions or need further assistance, please feel free to reach out to us at **[[email protected]](mailto:[email protected])**.
291
293
292
294
295
+
## Singul
296
+
Singul are a new way Shuffle interacts with data, built brick by brick since introducing Shuffle's Integration Layer API in early 2023. The goal of Singul is to enable ourselves and others to be able to perform actions towards a specific API, without necessarily know how to do it specifically for that system.
297
+
298
+
As of early 2024, this system is in active development, and we will implement features with it and help third party platforms do the same throughout the next few years.
299
+
300
+
**Example usecases:**
301
+
- Listing assets from your asset management system/CMDB to make a list of assets, without needing to know the Assets' API
302
+
- Blocking an Endpoint without knowing how to use the EDR API. Add this as a button to the list from the previous usecase
303
+
- Shuffle Notification Workflow: Get notifications directly to your ticketing system with minimal configuration
The Singul system is based on [generative AI for automatic mapping of fields (Schemaless)](https://github.com/frikky/schemaless), uses Github to [store configurations (Standards)](https://github.com/shuffle/standards), and uses [Shuffle's Integration Layer API](https://shuffler.io/docs/API#integration-layer) to run the actions.
308
+
309
+
## AI Agents
310
+
AI Agents are in active development as of April 2025. They take input(s) and automatically do the tasks for you, running in unison with [Singul](#singul) to perform tasks. This will be published to everyone as soon as it:
311
+
1. Has an interface allowing interactivity
312
+
2. Works with local models + Shuffle AI inference (for open sourcing)
313
+
3. Has good reasoning capabilities to handle decisionmaking
CACAO is a standardization framework for playbooks. It is still lacking significantly in capabilities as compared to Shuffle's own workflow system, but may be a good way to handle interoperability.
3. Ensure Shuffle Workflow -> CACAO playbook exports work well
323
+
324
+
Shuffle may in the future be based on CACAO playbooks to make workflow documentation work better.
325
+
293
326
## Detection Manager
294
327
The Shuffle Detection Manager is a system introduced in beta in December 2024, allowing Shuffle to work with platforms like Tenzir and other systems to help with Detection Engineering. The goal of the system is not to replace actual detection systems themselves, but to offer a centralized way to control Detection rules across tenants and different tools. As an example, **below is a focus on Sigma rules with Tenzir**. The system is tested with Yara rules, Email detection rules and custom rule systems.
295
328
@@ -402,20 +435,6 @@ KMS is supported for any system as long as the sections above are covered. It ha
402
435
- AliCloud
403
436
- ... and more! Ask if you need help.
404
437
405
-
## Native Actions
406
-
Native Actions are a new way Shuffle interacts with data, built brick by brick since introducing Shuffle's Integration Layer API in late 2022. The goal of Native Actions is to enable ourselves and others to be able to perform actions towards a specific API, without necessarily know how to do it specifically for that system.
407
-
408
-
As of early 2024, this system is in active development, and we will implement features with it and help third party platforms do the same throughout the next few years.
409
-
410
-
**Example usecases:**
411
-
- Listing assets from your asset management system/CMDB to make a list of assets, without needing to know the Assets' API
412
-
- Blocking an Endpoint without knowing how to use the EDR API. Add this as a button to the list from the previous usecase
413
-
- Shuffle Notification Workflow: Get notifications directly to your ticketing system with minimal configuration
The Native Actions system is based on [generative AI for automatic mapping of fields (Schemaless)](https://github.com/frikky/schemaless), uses Github to [store configurations (Standards)](https://github.com/shuffle/standards), and uses [Shuffle's Integration Layer API](https://shuffler.io/docs/API#integration-layer) to run the actions.
418
-
419
438
## Inbound Webhooks
420
439
This section describes inbound webhooks to Shuffle, and how to set them up in many commonly used third-party systems. If your system support outbound Webhooks, it can also forward to Shuffle as a GET or POST request. [More about webhook triggers](/triggers/#webhooks)
0 commit comments