# Inngest

> Send events and inspect apps, functions and runs in an Inngest environment.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/inngest

## Actions

### Cancel function run

Cancels an in-progress function run

**Inputs**

- Run (`run_id`, text, required): Run ID.

**Outputs**

- `data` (object): Result.

**Example output**

```json
{
  "data": {
    "data": {
      "runId": "example"
    },
    "metadata": {
      "cachedUntil": "example",
      "fetchedAt": "example",
      "timeRange": {
        "from": "example",
        "until": "example"
      }
    }
  }
}
```

### Get account

Returns the account for the authenticated user

**Inputs**: None.

**Outputs**

- `data` (object): Result.

**Example output**

```json
{
  "data": {
    "data": {
      "createdAt": "example",
      "email": "example",
      "id": "example",
      "name": "example",
      "updatedAt": "example"
    },
    "metadata": {
      "cachedUntil": "example",
      "fetchedAt": "example",
      "timeRange": {
        "from": "example",
        "until": "example"
      }
    }
  }
}
```

### Get app

Fetches details for a single app, including sync metadata and function count

**Inputs**

- App (`app_id`, text, required): The user-defined app ID

**Outputs**

- `data` (object): Result.

**Example output**

```json
{
  "data": {
    "data": {
      "appVersion": "example",
      "archivedAt": "example",
      "createdAt": "example",
      "functionCount": 1,
      "id": "example",
      "isArchived": false,
      "latestSync": {
        "appVersion": "example",
        "error": "example",
        "framework": "example",
        "sdkLanguage": "example",
        "sdkVersion": "example",
        "status": "example",
        "syncedAt": "example",
        "url": "example"
      },
      "method": "example",
      "name": "example"
    },
    "metadata": {
      "cachedUntil": "example",
      "fetchedAt": "example",
      "timeRange": {
        "from": "example",
        "until": "example"
      }
    }
  }
}
```

### Get app sync

Gets an app sync. Cloud keeps syncs until the app is deleted, with no separate retention window. The dev server does not support sync history and returns 501 for both list and get. Use GetApp latestSync for the dev server's current state.

**Inputs**

- App (`app_id`, text, required): The user-defined app ID
- Sync (`sync_id`, text, required): Sync UUID

**Outputs**

- `data` (object): Result.

**Example output**

```json
{
  "data": {
    "data": {
      "appId": "example",
      "appVersion": "example",
      "createdAt": "example",
      "error": {
        "code": "example",
        "message": "example"
      },
      "framework": "example",
      "id": "example",
      "sdkLanguage": "example",
      "sdkVersion": "example",
      "status": "example",
      "url": "example"
    },
    "metadata": {
      "cachedUntil": "example",
      "fetchedAt": "example",
      "timeRange": {
        "from": "example",
        "until": "example"
      }
    }
  }
}
```

### Get event

Gets an event by its internal ID. Internal inngest/ events are not returned. Payloads are omitted unless include=payload. The dev server returns events stored in its database, which is in-memory by default and lost on restart. Cloud returns the same events as the dashboard…

**Inputs**

- Event ID (`event_id`, text, required): Internal event ULID, also used by GetEventRuns.
- Include (`include`, list): Optional event expansions. Use payload to return the stored event JSON. Payloads can contain personal data and be large, so request them only when needed. Default CLI and MCP OAuth scopes include events:read:*, so agents can read payloads. Events can be up to 5 MiB in Cloud…. One or more of: `payload`.

**Outputs**

- `data` (object): Result.

**Example output**

```json
{
  "data": {
    "data": {
      "id": "example",
      "idempotencyKey": "example",
      "name": "example",
      "occurredAt": "example",
      "payload": {},
      "receivedAt": "example",
      "source": {
        "id": "example",
        "name": "example"
      },
      "version": "example"
    },
    "metadata": {
      "cachedUntil": "example",
      "fetchedAt": "example",
      "timeRange": {
        "from": "example",
        "until": "example"
      }
    }
  }
}
```

### Get function

Fetches function configuration and status details for a function within an app

**Inputs**

- App (`app_id`, text, required): App ID.
- Function (`function_id`, text, required): Function ID.

**Outputs**

- `data` (object): Result.

**Example output**

```json
{
  "data": {
    "data": {
      "app": {
        "id": "example"
      },
      "configuration": {
        "cancellations": [],
        "concurrency": [],
        "debounce": {
          "key": "example",
          "period": "example"
        },
        "eventsBatch": {
          "key": "example",
          "maxSize": 1,
          "timeout": "example"
        },
        "priority": "example",
        "rateLimit": {
          "key": "example",
          "limit": 1,
          "period": "example"
        },
        "retries": {
          "isDefault": false,
          "value": 1
        },
        "singleton": {
          "key": "example",
          "mode": "example"
        },
        "throttle": {
          "burst": 1,
          "key": "example",
          "limit": 1,
          "period": "example"
        }
      },
      "failureHandler": {
        "name": "example",
        "slug": "example"
      },
      "id": "example",
      "isArchived": false,
      "isPaused": false,
      "name": "example",
      "slug": "example",
      "triggers": []
    },
    "metadata": {
      "cachedUntil": "example",
      "fetchedAt": "example",
      "timeRange": {
        "from": "example",
        "until": "example"
      }
    }
  }
}
```

### Get function run

Fetches the canonical run summary for a single function run

**Inputs**

- Run (`run_id`, text, required): Run ID.
- Include (`include`, list): Optional run expansions selected by their lowerCamelCase API names. One or more of: `output`.

**Outputs**

- `data` (object): Result.

**Example output**

```json
{
  "data": {
    "data": {
      "app": {
        "id": "example"
      },
      "deferredFrom": {
        "functionName": "example",
        "functionSlug": "example"
      },
      "durationMs": "example",
      "endedAt": "example",
      "function": {
        "app": {
          "id": "example"
        },
        "id": "example",
        "name": "example",
        "slug": "example"
      },
      "id": "example",
      "isDeferred": false,
      "output": {},
      "queuedAt": "example",
      "startedAt": "example",
      "status": "example",
      "trigger": {
        "batchId": "example",
        "cronSchedule": "example",
        "eventIds": [],
        "eventName": "example",
        "isBatch": false
      }
    },
    "metadata": {
      "cachedUntil": "example",
      "fetchedAt": "example",
      "timeRange": {
        "from": "example",
        "until": "example"
      }
    }
  }
}
```

### Get function trace

Fetches the trace tree for a single function run

**Inputs**

- Run (`run_id`, text, required): Run ID.
- Include (`include`, list): Optional trace expansions selected by their lowerCamelCase API names. One or more of: `output`.

**Outputs**

- `data` (object): Result.

**Example output**

```json
{
  "data": {
    "data": {
      "rootSpan": {
        "children": [],
        "durationMs": "example",
        "endedAt": "example",
        "groupKind": "example",
        "id": "example",
        "input": {},
        "metadata": [],
        "name": "example",
        "origin": "example",
        "output": {},
        "queuedAt": "example",
        "startedAt": "example",
        "status": "example",
        "stepId": "example",
        "stepOp": "example",
        "stepType": "example"
      },
      "runId": "example"
    },
    "metadata": {
      "cachedUntil": "example",
      "fetchedAt": "example",
      "timeRange": {
        "from": "example",
        "until": "example"
      }
    }
  }
}
```

### Invoke function

Invokes a function, executing the function either asynchronously or synchronously based on the mode parameter in the request body

**Inputs**

- App (`app_id`, text, required): The ID of the app containing the function
- Function (`function_id`, text, required): The ID of the function to invoke
- Data (`data`, object): JSON object containing the input data for the function
- Idempotency key (`idempotency_key`, text): Optional idempotency key to handle duplicate requests within a given idempotency period.

**Outputs**

- `data` (object): Result.

**Example output**

```json
{
  "data": {
    "data": {
      "completedAt": "example",
      "error": "example",
      "queuedAt": "example",
      "result": "example",
      "runId": "example",
      "startedAt": "example"
    },
    "metadata": {
      "cachedUntil": "example",
      "fetchedAt": "example",
      "timeRange": {
        "from": "example",
        "until": "example"
      }
    }
  }
}
```

### List app syncs

Lists app syncs newest first. Cloud keeps syncs until the app is deleted, with no separate retention window. The dev server does not support sync history and returns 501 for both list and get. Use GetApp latestSync for the dev server's current state.

**Inputs**

- App (`app_id`, text, required): The user-defined app ID
- Cursor (`cursor`, text): Pagination cursor from previous response: the UUID of the last returned sync
- Limit (`limit`, number): Number of syncs to return per page: 1-100; 0 or omitted uses 20. Default: `20`.

**Outputs**

- `data` (object): Result.

**Example output**

```json
{
  "data": {
    "data": [],
    "metadata": {
      "cachedUntil": "example",
      "fetchedAt": "example",
      "timeRange": {
        "from": "example",
        "until": "example"
      }
    },
    "page": {
      "cursor": "example",
      "hasMore": false,
      "limit": 1
    }
  }
}
```

### List apps

Lists active apps in the authenticated environment. Set archived to true to list archived apps instead.

**Inputs**

- Cursor (`cursor`, text): Pagination cursor from previous response
- Limit (`limit`, number): Number of apps to return per page (min: 1, max: 100). Default: `20`.
- Archived (`archived`, true/false): Whether to return archived apps instead of active apps. Default: `false`.

**Outputs**

- `data` (object): Result.

**Example output**

```json
{
  "data": {
    "data": [],
    "metadata": {
      "cachedUntil": "example",
      "fetchedAt": "example",
      "timeRange": {
        "from": "example",
        "until": "example"
      }
    },
    "page": {
      "cursor": "example",
      "hasMore": false,
      "limit": 1
    }
  }
}
```

### List event runs

Lists function runs triggered by a specific event

**Inputs**

- Event ID (`event_id`, text, required): Event ID.
- Cursor (`cursor`, text): Pagination cursor from previous response
- Limit (`limit`, number): Number of runs to return per page (min: 1, max: 40). Default: `20`.
- Include (`include`, list): Optional run expansions selected by their lowerCamelCase API names. One or more of: `output`.

**Outputs**

- `data` (object): Result.

**Example output**

```json
{
  "data": {
    "data": [],
    "metadata": {
      "cachedUntil": "example",
      "fetchedAt": "example",
      "timeRange": {
        "from": "example",
        "until": "example"
      }
    },
    "page": {
      "cursor": "example",
      "hasMore": false,
      "limit": 1
    }
  }
}
```

### List events

Lists events in descending internal-ID order, excluding internal inngest/ events. Time filters use received time; client-seeded IDs can differ from received-time order. Payloads are omitted unless include=payload. The dev server returns events stored in its database, which…

**Inputs**

- Cursor (`cursor`, text): ID of the last returned event from the previous response. Reuse the same filters and metadata.timeRange on subsequent pages.
- Limit (`limit`, number): Number of events per page (min: 1, max: 50). With include=payload the maximum and default are 5; otherwise the default is 40. Zero uses the default. Events can be up to 5 MiB in Cloud (less on lower plans). Default: `40`.
- Start time (`start_time`, date and time): Inclusive received-time lower bound. Defaults to one hour before until, or one hour before the current time if until is omitted. Must not be after until. The effective window is returned in metadata.timeRange.
- End time (`end_time`, date and time): Inclusive received-time upper bound. Defaults to the current time. When from is omitted, it defaults to one hour before this bound. The effective window is returned in metadata.timeRange.
- Name (`name`, list): Exact event names to include. Repeat to match any of up to 20 names, with up to 256 characters each and no backslashes or control characters.
- Include (`include`, list): Optional event expansions. Use payload to return the stored event JSON. Payloads can contain personal data and be large, so request them only when needed. Default CLI and MCP OAuth scopes include events:read:*, so agents can read payloads. One or more of: `payload`.

**Outputs**

- `data` (object): Result.

**Example output**

```json
{
  "data": {
    "data": [],
    "metadata": {
      "cachedUntil": "example",
      "fetchedAt": "example",
      "timeRange": {
        "from": "example",
        "until": "example"
      }
    },
    "page": {
      "cursor": "example",
      "hasMore": false,
      "limit": 1
    }
  }
}
```

### List function runs

Lists runs for one function in the authenticated environment

**Inputs**

- App (`app_id`, text, required): App ID.
- Function (`function_id`, text, required): Function ID.
- Cursor (`cursor`, text): Pagination cursor from previous response
- Limit (`limit`, number): Number of runs to return per page (min: 1, max: 100). Default: `20`.
- Start time (`start_time`, date and time): Inclusive start of the run time range
- End time (`end_time`, date and time): Inclusive end of the run time range
- Time field (`time_field`, text): Run timestamp field used for filtering and ordering. Accepts queuedAt, startedAt, or endedAt. Snake case aliases such as QUEUED_AT, STARTED_AT, and ENDED_AT are also accepted. Default: `queuedAt`.
- Status (`status`, list): Statuses to include, using response status values such as COMPLETED, FAILED, RUNNING, QUEUED, CANCELLED, SKIPPED, or PAUSED
- Is deferred (`is_deferred`, true/false): Whether to include only deferred or non-deferred runs
- Order (`order`, text): Sort direction. Accepts ASC or DESC. Default: `DESC`.
- Query (`query`, text): CEL expression used to filter runs by event, output, or error data
- Include (`include`, list): Optional run expansions selected by their lowerCamelCase API names. One or more of: `output`, `deferredFrom`.

**Outputs**

- `data` (object): Result.

**Example output**

```json
{
  "data": {
    "data": [],
    "metadata": {
      "cachedUntil": "example",
      "fetchedAt": "example",
      "timeRange": {
        "from": "example",
        "until": "example"
      }
    },
    "page": {
      "cursor": "example",
      "hasMore": false,
      "limit": 1
    }
  }
}
```

### List functions

Lists function configuration and status details for an app

**Inputs**

- App (`app_id`, text, required): App ID.
- Cursor (`cursor`, text): Pagination cursor from previous response
- Limit (`limit`, number): Number of functions to return per page (min: 1, max: 100). Default: `20`.

**Outputs**

- `data` (object): Result.

**Example output**

```json
{
  "data": {
    "data": [],
    "metadata": {
      "cachedUntil": "example",
      "fetchedAt": "example",
      "timeRange": {
        "from": "example",
        "until": "example"
      }
    },
    "page": {
      "cursor": "example",
      "hasMore": false,
      "limit": 1
    }
  }
}
```

### List runs

Lists runs in the authenticated environment, optionally filtered by app and function IDs

**Inputs**

- Cursor (`cursor`, text): Pagination cursor from previous response
- Limit (`limit`, number): Number of runs to return per page (min: 1, max: 100). Default: `20`.
- Start time (`start_time`, date and time): Inclusive start of the run time range
- End time (`end_time`, date and time): Inclusive end of the run time range
- Time field (`time_field`, text): Run timestamp field used for filtering and ordering. Accepts queuedAt, startedAt, or endedAt. Snake case aliases such as QUEUED_AT, STARTED_AT, and ENDED_AT are also accepted. Default: `queuedAt`.
- Status (`status`, list): Statuses to include, using response status values such as COMPLETED, FAILED, RUNNING, QUEUED, CANCELLED, SKIPPED, or PAUSED
- App (`app_id`, list): App IDs to include
- Function ID (`function_id`, list): Function IDs to include
- Is deferred (`is_deferred`, true/false): Whether to include only deferred or non-deferred runs
- Order (`order`, text): Sort direction. Accepts ASC or DESC. Default: `DESC`.
- Query (`query`, text): CEL expression used to filter runs by event, output, or error data
- Include (`include`, list): Optional run expansions selected by their lowerCamelCase API names. One or more of: `output`, `deferredFrom`.

**Outputs**

- `data` (object): Result.

**Example output**

```json
{
  "data": {
    "data": [],
    "metadata": {
      "cachedUntil": "example",
      "fetchedAt": "example",
      "timeRange": {
        "from": "example",
        "until": "example"
      }
    },
    "page": {
      "cursor": "example",
      "hasMore": false,
      "limit": 1
    }
  }
}
```

### Pause function

Pauses a function. Idempotent: pausing a paused function returns 200 and changes nothing. Send no request body. Runs already executing may continue. In Cloud, the pause can take up to a minute to apply, new runs are skipped while paused, and runs still unfinished after 7…

**Inputs**

- App (`app_id`, text, required): App ID.
- Function (`function_id`, text, required): Function ID.

**Outputs**

- `data` (object): Result.

**Example output**

```json
{
  "data": {
    "data": {
      "app": {
        "id": "example"
      },
      "configuration": {
        "cancellations": [],
        "concurrency": [],
        "debounce": {
          "key": "example",
          "period": "example"
        },
        "eventsBatch": {
          "key": "example",
          "maxSize": 1,
          "timeout": "example"
        },
        "priority": "example",
        "rateLimit": {
          "key": "example",
          "limit": 1,
          "period": "example"
        },
        "retries": {
          "isDefault": false,
          "value": 1
        },
        "singleton": {
          "key": "example",
          "mode": "example"
        },
        "throttle": {
          "burst": 1,
          "key": "example",
          "limit": 1,
          "period": "example"
        }
      },
      "failureHandler": {
        "name": "example",
        "slug": "example"
      },
      "id": "example",
      "isArchived": false,
      "isPaused": false,
      "name": "example",
      "slug": "example",
      "triggers": []
    },
    "metadata": {
      "cachedUntil": "example",
      "fetchedAt": "example",
      "timeRange": {
        "from": "example",
        "until": "example"
      }
    }
  }
}
```

### Rerun function

Creates a new run using the original run's triggering event data

**Inputs**

- Run (`run_id`, text, required): Run ID.
- From step (`from_step`, object): From step.

**Outputs**

- `data` (object): Result.

**Example output**

```json
{
  "data": {
    "data": {
      "runId": "example"
    },
    "metadata": {
      "cachedUntil": "example",
      "fetchedAt": "example",
      "timeRange": {
        "from": "example",
        "until": "example"
      }
    }
  }
}
```

### Resume function

Resumes a paused function. Idempotent: resuming a function that is not paused returns 200 with isPaused: false. The dev server still wakes the queue so retries can recover a failed wake. Send no request body. In Cloud, the response reflects the requested state; the resume…

**Inputs**

- App (`app_id`, text, required): App ID.
- Function (`function_id`, text, required): Function ID.

**Outputs**

- `data` (object): Result.

**Example output**

```json
{
  "data": {
    "data": {
      "app": {
        "id": "example"
      },
      "configuration": {
        "cancellations": [],
        "concurrency": [],
        "debounce": {
          "key": "example",
          "period": "example"
        },
        "eventsBatch": {
          "key": "example",
          "maxSize": 1,
          "timeout": "example"
        },
        "priority": "example",
        "rateLimit": {
          "key": "example",
          "limit": 1,
          "period": "example"
        },
        "retries": {
          "isDefault": false,
          "value": 1
        },
        "singleton": {
          "key": "example",
          "mode": "example"
        },
        "throttle": {
          "burst": 1,
          "key": "example",
          "limit": 1,
          "period": "example"
        }
      },
      "failureHandler": {
        "name": "example",
        "slug": "example"
      },
      "id": "example",
      "isArchived": false,
      "isPaused": false,
      "name": "example",
      "slug": "example",
      "triggers": []
    },
    "metadata": {
      "cachedUntil": "example",
      "fetchedAt": "example",
      "timeRange": {
        "from": "example",
        "until": "example"
      }
    }
  }
}
```

### Send event

Send one event to your Inngest environment. Use this action for testing and low-volume workflows.

**Inputs**

- Data (`data`, object): JSON object containing event data
- ID (`id`, text): Optional event ID used for idempotency when scheduling function runs
- Name (`name`, text, required): Event name
- Event time (`occurred_at`, date and time): Optional event timestamp as Unix time in milliseconds. Defaults to the current time.
- User (`user`, object): Deprecated user data. Put user data in the data field instead.

**Outputs**

- `data` (object): Result.

**Example output**

```json
{
  "data": {
    "data": {
      "eventId": "example"
    },
    "metadata": {
      "cachedUntil": "example",
      "fetchedAt": "example",
      "timeRange": {
        "from": "example",
        "until": "example"
      }
    }
  }
}
```
