events: add documentation for main event types with example payloads

docs/api-reference/v2/endpoints/activities/get-fireworkv2activities-.mdx

@@ -3,6 +3,9 @@ openapi: firework-v2-openapi get /firework/v2/activities/
 title: Retrieve Event
 ---
 
+This response changes based on the event type, for more information the various possible responses, see
+[Event Types <Icon icon="book" size={16} />](/event-types/).
+
 <Note>
 For backwards compatibility, this endpoint is also available as `/firework/v2/activities/{index}/{source}/{id}`.
 </Note>

docs/changelog/overview.mdx

@@ -12,6 +12,11 @@ This page lists changes to Flare's API.
 Release notes for the Flare Platform can be found on the [product documentation website](https://docs.flare.io/releases).
 </Note>
 
+<Update label="2025-10" description="API - October 2025">
+  Added documentation for
+  [Flare API Event Types <Icon icon="book" size={16} />](/event-types/overview).
+</Update>
+
 <Update label="2025-08" description="API - August 2025">
   API endpoints using the `/leaksdb/` prefix were changed to `/astp/`.
   The old prefix remains available as an alias and there are no plans to deprecate it.
@@ -20,7 +25,7 @@ Release notes for the Flare Platform can be found on the [product documentation
 <Update label="2025-07" description="MCP - July 2025">
   Released the
   [Flare API Documentation MCP Server <Icon icon="book" size={16} />](/sdk/mcp).
-  
+
   This is useful for developers building Flare API automations with AI-powered integrated development environments (IDE).
 </Update>
 
@@ -46,7 +51,7 @@ Release notes for the Flare Platform can be found on the [product documentation
 </Update>
 
 <Update label="2025-04" description="API - April 2025">
-  Released a new version of the List All Credentials endpoint, 
+  Released a new version of the List All Credentials endpoint,
   [List All Credentials V2 <Icon icon="code" size={16} />](/api-reference/leaksdb/endpoints/get-credentials-v2),
   which supports the
   [Flare standard paging pattern <Icon icon="book" size={16} />](/concepts/paging).

docs/docs.json

@@ -260,6 +260,33 @@
           }
         ]
       },
+      {
+        "tab": "Event Types",
+        "groups": [
+          {
+            "group": "Events",
+            "pages": [
+              "event-types/overview",
+              "event-types/blog-post",
+              "event-types/bucket-object",
+              "event-types/bucket",
+              "event-types/document",
+              "event-types/domain",
+              "event-types/experimental",
+              "event-types/forum-post",
+              "event-types/forum-topic",
+              "event-types/google",
+              "event-types/leak",
+              "event-types/listing",
+              "event-types/paste",
+              "event-types/profile",
+              "event-types/seller",
+              "event-types/source-code",
+              "event-types/stealer-log"
+            ]
+          }
+        ]
+      },
       {
         "tab": "Changelog",
         "groups": [
@@ -296,9 +323,7 @@
       "display": "interactive"
     },
     "mdx": {
-      "server": [
-        "http://api.flare.io/"
-      ],
+      "server": ["http://api.flare.io/"],
       "auth": {
         "method": "bearer"
       }

docs/event-types/blog-post.mdx

@@ -0,0 +1,74 @@
+---
+title: "Blog Post"
+---
+
+The `blog_post` type represents blog-style documents and text-based publications that have been discovered and indexed by Flare across document-sharing or content-hosting platforms such as Scribd, Medium, or public paste/document repositories.  
+These records generally include technical manuals, guides, or articles that are accessible to the public, potentially containing sensitive, proprietary, or copyrighted materials.
+
+```json Example Content
+{
+  "id": "example-id-12345",
+  "title": "Example Technical Document | PDF | Mechanical Part | Component Type",
+  "description": "Example Product Line Full Description",
+  "content": "Brief summary of the document contents",
+  "url": "https://example.com/document/example-id-12345",
+  "browser_url": "https://example.com/document/example-id-12345",
+  "metadata": {
+    "estimated_created_at": "2025-10-27T05:51:19.667458+00:00",
+    "event_id": null,
+    "first_crawled_at": "2025-10-27T05:51:19.667458+00:00",
+    "last_crawled_at": "2025-10-27T05:51:19.667458+00:00",
+    "payload_digest": "hashvalue123abc",
+    "scraped_at": "2025-10-27T05:51:22.483346+00:00",
+    "source": "example_source",
+    "crawled_by": null,
+    "flare_url": "https://app.flare.io/#/blog_post/scribd/example-id-12345"
+  },
+  "header": {
+    "actor": "John Doe",
+    "actor_id": null,
+    "category_name": "",
+    "content_hash": "hashvalue123abc",
+    "content_preview": "Short excerpt from the document text",
+    "country": null,
+    "duplicates": [],
+    "es_score": 1.0,
+    "expiration": null,
+    "highlights": {},
+    "id": "example-id-12345",
+    "parent_id": null,
+    "parent_title": null,
+    "parent_title_en": null,
+    "parent_uid": null,
+    "parent_uids": [],
+    "risk": { "score": 2 },
+    "similar_items_count": 0,
+    "source": "example_source",
+    "source_name": "Example Platform",
+    "target_name": "Example Platform",
+    "tags": [],
+    "notes": null,
+    "state_code": null,
+    "timestamp": "2025-10-27T05:51:19.667458+00:00",
+    "title": "Example Technical Document | PDF | Mechanical Part | Component Type",
+    "type": "blog_post",
+    "uid": "blog_post/example_source/example-id-12345",
+    "user_risk_score": null,
+    "user_notes": null,
+    "ignored_at": null,
+    "remediated_at": null,
+    "verb": "posted",
+    "external_url": null,
+    "external_netloc": null,
+    "can_have_duplicates": true,
+    "priority_action_uuid_related": false,
+    "victim_name": null,
+    "contains_secrets": null,
+    "secrets_metadata": null
+  },
+  "duplicates": [],
+  "history_logs": null,
+  "similar_items": []
+}
+
+```

docs/event-types/bucket-object.mdx

@@ -0,0 +1,143 @@
+---
+title: "Bucket Object"
+---
+
+The `bucket_object` type represents individual files (objects) discovered within publicly exposed cloud storage buckets, such as those hosted on Amazon S3, Azure Blob Storage, or Google Cloud Storage.  
+Each record identifies a single accessible object, typically containing metadata like its bucket location, provider, file path, and exposure source.  
+
+```json Example Content
+{
+  "id": "example-id-67890",
+  "title": "Example Bucket Object [email protected]",
+  "content": null,
+  "content_en": null,
+  "url": null,
+  "browser_url": null,
+  "metadata": {
+    "estimated_created_at": "2022-09-29T05:41:31.384630+00:00",
+    "event_id": null,
+    "first_crawled_at": "2022-09-29T05:41:31.384630+00:00",
+    "last_crawled_at": "2022-10-03T01:32:45.841604+00:00",
+    "payload_digest": null,
+    "scraped_at": "2022-10-03T01:32:45.845075+00:00",
+    "source": "example_source",
+    "crawled_by": null,
+    "flare_url": "https://app.flare.io/#/bucket_object/grayhat_warfare/example-id-67890"
+  },
+  "bucket": {
+    "host": "example.blob.core.windows.net",
+    "bucket_id": "example-bucket-id",
+    "id": "azure/example-bucket-id",
+    "provider": "azure"
+  },
+  "commit": {
+    "author_email": null,
+    "author_id": null,
+    "author_name": null,
+    "committer_email": null,
+    "committer_id": null,
+    "committer_name": null,
+    "sha": null,
+    "patch_url": null
+  },
+  "code": {
+    "commit_name": null,
+    "commit_date": null,
+    "path": null,
+    "commit_email": null
+  },
+  "drill_type": "bucket_object",
+  "dork_name": null,
+  "html_url": null,
+  "is_secret_detection_rule_match": null,
+  "issue": {
+    "id": null,
+    "state": null,
+    "title": null,
+    "tags": null,
+    "assignee_id": null,
+    "assignee_name": null
+  },
+  "project_name": null,
+  "project": {
+    "owner_name": null,
+    "owner_id": null,
+    "owner_type": null,
+    "tags": null,
+    "last_activity_at": null,
+    "language": null,
+    "followers_count": null,
+    "forks_count": null,
+    "is_fork": null
+  },
+  "resource_url": [
+    "https://example.blob.core.windows.net/publiccontainer/Users/[email protected]"
+  ],
+  "secret_detection_rule_id": null,
+  "snippets": null,
+  "user": {
+    "email": null,
+    "company": null,
+    "full_name": null,
+    "location": null,
+    "followers_count": null
+  },
+  "features": {
+    "domains": ["example.blob.core.windows.net"],
+    "emails": null,
+    "ip_addresses": null,
+    "ip_addresses_cidr": null,
+    "reversed_domains": ["net.windows.core.blob.example"],
+    "urls": ["https://example.blob.core.windows.net/publiccontainer/Users/[email protected]"],
+    "usernames": null,
+    "vulnerabilities": null
+  },
+  "duplicates": [],
+  "header": {
+    "actor": "",
+    "actor_id": null,
+    "category_name": "Drill",
+    "content_hash": "bucket_object/example_source/example-id-67890",
+    "content_preview": "[email protected] on Azure at example.blob.core.windows.net",
+    "country": null,
+    "duplicates": [],
+    "es_score": 1.0,
+    "expiration": null,
+    "highlights": {},
+    "host": null,
+    "id": "example-id-67890",
+    "infection_date": null,
+    "parent_id": null,
+    "parent_title": null,
+    "parent_title_en": null,
+    "parent_uid": null,
+    "parent_uids": [],
+    "risk": { "score": 2 },
+    "similar_items_count": 0,
+    "source": "example_source",
+    "source_name": "Example Source",
+    "target_name": "Example Target",
+    "tags": [],
+    "notes": null,
+    "state_code": null,
+    "timestamp": "2022-09-29T05:41:31.384630+00:00",
+    "title": "Example Bucket Object [email protected]",
+    "type": "bucket_object",
+    "uid": "bucket_object/example_source/example-id-67890",
+    "user_risk_score": null,
+    "user_notes": null,
+    "ignored_at": null,
+    "remediated_at": null,
+    "verb": "pushed",
+    "external_url": "https://example.blob.core.windows.net/publiccontainer/Users/[email protected]",
+    "external_netloc": "example.blob.core.windows.net",
+    "can_have_duplicates": true,
+    "priority_action_uuid_related": false,
+    "victim_name": null,
+    "contains_secrets": false,
+    "secrets_metadata": []
+  },
+  "history_logs": null,
+  "similar_items": []
+}
+```

docs/event-types/bucket.mdx

@@ -0,0 +1,89 @@
+---
+title: "Bucket"
+---
+
+The `bucket` type represents publicly exposed cloud storage containers, such as Amazon S3, Azure Blob, or Google Cloud Storage buckets.  
+These records document information about misconfigured or accessible cloud storage endpoints, including domain names, providers, and discovered files.  
+
+```json Example Content
+{
+  "id": "example-id-34567",
+  "title": "Example Bucket example-bucket.s3.amazonaws.com on Aws",
+  "url": null,
+  "browser_url": null,
+  "metadata": {
+    "estimated_created_at": "2022-07-20T08:01:19.174392+00:00",
+    "event_id": null,
+    "first_crawled_at": "2022-07-20T08:01:19.174392+00:00",
+    "last_crawled_at": "2022-08-15T04:24:18.493735+00:00",
+    "payload_digest": null,
+    "scraped_at": "2022-08-15T04:24:18.495069+00:00",
+    "source": "example_source",
+    "crawled_by": null,
+    "flare_url": "https://app.flare.io/#/bucket/grayhat_warfare/example-id-34567"
+  },
+  "resource_url": "https://example-bucket.s3.amazonaws.com",
+  "domain": "example-bucket.s3.amazonaws.com",
+  "provider": "aws",
+  "content_type": null,
+  "file_count": 1,
+  "files": [],
+  "features": {
+    "domains": ["example-bucket.s3.amazonaws.com"],
+    "emails": null,
+    "ip_addresses": null,
+    "ip_addresses_cidr": null,
+    "reversed_domains": ["com.amazonaws.s3.example-bucket"],
+    "urls": null,
+    "usernames": null,
+    "vulnerabilities": null
+  },
+  "duplicates": [],
+  "header": {
+    "actor": "",
+    "actor_id": null,
+    "category_name": "aws",
+    "content_hash": "bucket/example_source/example-id-34567",
+    "content_preview": "",
+    "country": null,
+    "duplicates": [],
+    "es_score": 1.0,
+    "expiration": null,
+    "highlights": {},
+    "host": null,
+    "id": "example-id-34567",
+    "infection_date": null,
+    "parent_id": null,
+    "parent_title": null,
+    "parent_title_en": null,
+    "parent_uid": null,
+    "parent_uids": [],
+    "risk": { "score": 2 },
+    "similar_items_count": 0,
+    "source": "example_source",
+    "source_name": "Example Source",
+    "target_name": "Example Target",
+    "tags": [],
+    "notes": null,
+    "state_code": null,
+    "timestamp": "2022-07-20T08:01:19.174392+00:00",
+    "title": "Example Bucket example-bucket.s3.amazonaws.com on Aws",
+    "type": "bucket",
+    "uid": "bucket/example_source/example-id-34567",
+    "user_risk_score": null,
+    "user_notes": null,
+    "ignored_at": null,
+    "remediated_at": null,
+    "verb": "",
+    "external_url": null,
+    "external_netloc": null,
+    "can_have_duplicates": true,
+    "priority_action_uuid_related": false,
+    "victim_name": null,
+    "contains_secrets": null,
+    "secrets_metadata": null
+  },
+  "history_logs": null,
+  "similar_items": []
+}
+```