# Schedule a data feed for your BI tool

Register a scheduled export of one record kind onto your export shelf, run it now when you cannot wait, and mint the short-lived link your tool pulls a file with.

Integrations · a play in 3 steps.

## The steps

1. Register the feed — the record kind and the cadence. — [createFeedSubscription](/reference/system-and-integration-setup/createFeedSubscription/)
2. Run it now instead of waiting. — [runFeedSubscriptionNow](/reference/system-and-integration-setup/runFeedSubscriptionNow/)
3. Mint the five-minute download link for a file. — [mintFeedRunDownload](/reference/system-and-integration-setup/mintFeedRunDownload/)

## The calls

Every operation this use case runs, in the order it first appears, with the request and the response its reference page shows.

### createFeedSubscription

[createFeedSubscription](/reference/system-and-integration-setup/createFeedSubscription/) — mutation · Register a scheduled BI feed — a file of one record kind (customers, products, vendors, orders, or the catalog) lands on your export shelf on a cadence.

**Example request**

```graphql
mutation ExampleCreateFeedSubscription($input: CreateFeedSubscriptionInput!) {
  createFeedSubscription(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    organizationId
    dataset
    cadence
    format
    nextDueAt
    lastRunAt
    lastRunKey
    consecutiveFailures
    lastFailureAt
    lastFailureCode
    suspendedAt
  }
}
```

Variables:

```json
{
  "input": {
    "caption": "Blue jeans",
    "organizationId": "01900000-0000-7000-8000-44b781470000",
    "dataset": "<dataset>",
    "cadence": "<cadence>",
    "format": "<format>"
  }
}
```

Send it with the envelope naming the version: `"extensions": {"at": {"version": {"name":"genesis","number":0}}}`.

**Example response**

```json
{
  "data": {
    "createFeedSubscription": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "FD-EXMP-0000-000F",
      "type": "FeedSubscription",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "organizationId": "01900000-0000-7000-8000-44b781470000",
      "dataset": "<dataset>",
      "cadence": "<cadence>",
      "format": "<format>",
      "nextDueAt": "2027-01-31T00:00:00.000Z",
      "lastRunAt": "2027-01-31T00:00:00.000Z",
      "lastRunKey": "<last run key>",
      "consecutiveFailures": 1,
      "lastFailureAt": "2027-01-31T00:00:00.000Z",
      "lastFailureCode": "BJ-001",
      "suspendedAt": "2027-01-31T00:00:00.000Z"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}
```

### runFeedSubscriptionNow

[runFeedSubscriptionNow](/reference/system-and-integration-setup/runFeedSubscriptionNow/) — mutation · Run a feed now instead of waiting for its cadence — the next hourly sweep exports it.

**Example request**

```graphql
mutation ExampleRunFeedSubscriptionNow($id: ID!, $revision: ID!, $reason: String) {
  runFeedSubscriptionNow(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    organizationId
    dataset
    cadence
    format
    nextDueAt
    lastRunAt
    lastRunKey
    consecutiveFailures
    lastFailureAt
    lastFailureCode
    suspendedAt
  }
}
```

Variables:

```json
{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "reason": "Correcting a miscount."
}
```

Send it with the envelope naming the version: `"extensions": {"at": {"version": {"name":"genesis","number":0}}}`.

**Example response**

```json
{
  "data": {
    "runFeedSubscriptionNow": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "FD-EXMP-0000-000F",
      "type": "FeedSubscription",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "organizationId": "01900000-0000-7000-8000-44b781470000",
      "dataset": "<dataset>",
      "cadence": "<cadence>",
      "format": "<format>",
      "nextDueAt": "2027-01-31T00:00:00.000Z",
      "lastRunAt": "2027-01-31T00:00:00.000Z",
      "lastRunKey": "<last run key>",
      "consecutiveFailures": 1,
      "lastFailureAt": "2027-01-31T00:00:00.000Z",
      "lastFailureCode": "BJ-001",
      "suspendedAt": "2027-01-31T00:00:00.000Z"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}
```

### mintFeedRunDownload

[mintFeedRunDownload](/reference/system-and-integration-setup/mintFeedRunDownload/) — mutation · Get a short-lived download link (5 minutes) for one of a feed’s files.

**Example request**

```graphql
mutation ExampleMintFeedRunDownload($feedSubscriptionId: ID!, $key: String!) {
  mintFeedRunDownload(feedSubscriptionId: $feedSubscriptionId, key: $key) {
    url
    expiresAt
  }
}
```

Variables:

```json
{
  "feedSubscriptionId": "01900000-0000-7000-8000-d71fef790000",
  "key": "<key>"
}
```

Send it with the envelope naming the version: `"extensions": {"at": {"version": {"name":"genesis","number":0}}}`.

**Example response**

```json
{
  "data": {
    "mintFeedRunDownload": {
      "url": "https://example.com/hook",
      "expiresAt": "2027-01-31T00:00:00.000Z"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}
```