{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference subpackage_accounts subpackage_events API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_events",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List events",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.x.flatfile.com/v1/events",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "environmentId",
                "value": "",
                "type": "query",
                "description": "Filter by environment"
              },
              {
                "name": "spaceId",
                "value": "",
                "type": "query",
                "description": "Filter by space"
              },
              {
                "name": "domain",
                "value": "",
                "type": "query",
                "description": "Filter by event domain"
              },
              {
                "name": "topic",
                "value": "",
                "type": "query",
                "description": "Filter by event topic"
              },
              {
                "name": "since",
                "value": "",
                "type": "query",
                "description": "Filter by event timestamp"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of results to return in a page (default 10)"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Based on pageSize, which page of results to return"
              },
              {
                "name": "includeAcknowledged",
                "value": "",
                "type": "query",
                "description": "Include acknowledged events"
              }
            ]
          },
          "docs": "Event topics that the Flatfile Platform emits."
        },
        {
          "info": {
            "name": "Create an event",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.x.flatfile.com/v1/events",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create an event"
        },
        {
          "info": {
            "name": "Get an event",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.x.flatfile.com/v1/events/:eventId",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "eventId",
                "value": "",
                "type": "path",
                "description": "The event id"
              }
            ]
          },
          "docs": "Get an event"
        },
        {
          "info": {
            "name": "Acknowledge an event",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.x.flatfile.com/v1/events/:eventId/ack",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "eventId",
                "value": "",
                "type": "path",
                "description": "The event id"
              }
            ]
          },
          "docs": "Acknowledge an event"
        },
        {
          "info": {
            "name": "Get subscription credentials",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.x.flatfile.com/v1/subscription",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Disable-Hooks",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "scope",
                "value": "",
                "type": "query",
                "description": "The resource ID of the event stream (space or environment id)"
              },
              {
                "name": "spaceId",
                "value": "",
                "type": "query",
                "description": "The space ID of the event stream"
              }
            ]
          },
          "docs": "Get a token which can be used to subscribe to events for this space"
        }
      ]
    }
  ],
  "bundled": true
}