# Inngest API

- [API Overview](/): Complete reference documentation for the Inngest REST API.
- [Authentication](/authentication): How to authenticate with the Inngest REST API.
- v1
  - [v1 REST API](/v1)

  - **Events**
  - [List events](/v1/events/ListEvents): Fetches recent events from your environment.
  - [Get an event](/v1/events/GetEvent): Retrieve a single event within your environment, given its internal ID
  - [List event function runs](/v1/events/ListEventRuns): Returns function runs initialized by the given event

  - **Function runs**
  - [Get a function run](/v1/function-runs/GetRun): Returns a single function run by its run ID
  - [Cancel a function run](/v1/function-runs/CancelRun): Cancels a running function immediately.  No new steps will run after a function is cancelled.
  - [Fetch function run jobs](/v1/function-runs/GetRunJobs): An endpoint to fetch a subset of the function run's jobs within the function_id queue, in order of earliest to latest. This primarily allows you to see the order of the run's jobs within the function queue.

A single function enqueues all function run jobs wihtin the same queue.  This endpoint fetches a subset of jobs for a given function run.

This endpoint is rate limited and cached for 5 seconds.

  - **Signals**
  - [Resume signal](/v1/signals/ResumeSignal): Sends data to resume a given signal

  - **Cancellations**
  - [List cancellations](/v1/cancellations/ListCancellations): Returns all cancellations in your environment
  - [Create a cancellation](/v1/cancellations/CreateCancellation): Creates a bulk cancellation, cancelling all functions in the given time range matching an optional expression
  - [Delete a cancellation](/v1/cancellations/DeleteCancellation): Delete a cancellation, preventing the cancellation from stopping function runs between the given dates with a given expression.

  - **Webhooks**
  - [Get webhooks](/v1/webhooks/ListWebhooks): Get all webhook endpoints in the given environment.
  - [Create webhook](/v1/webhooks/CreateWebhook): Create a new webhook endpoint with the given configuration.
  - [Get webhook](/v1/webhooks/GetWebhook): Get a webhook endpoint's configuration
  - [Delete webhook](/v1/webhooks/DeleteWebhook): Delete a webhook endpoint
  - [Update webhook](/v1/webhooks/UpdateWebhook): Update a webhook endpoint's configuration
- v2

  - **Account**
  - [Get account](/v2/account/FetchAccount): Returns the account for the authenticated user

  - **Functions**
  - [Invoke function](/v2/functions/InvokeFunction): Invokes a function, executing the function either asynchronously or synchronously based on the mode parameter in the request body

  - **Apps**
  - [Sync app](/v2/apps/SyncApp): Sync an app at the provided URL.

  - **Webhooks**
  - [List webhooks](/v2/webhooks/ListWebhooks): Lists all webhooks in the specified environment
  - [Create webhook](/v2/webhooks/CreateWebhook): Creates a new webhook for receiving events

  - **Environments**
  - [List environments](/v2/environments/FetchAccountEnvs): List of all custom environments.
  - [Create environment](/v2/environments/CreateEnv): Create custom environment
  - [Update environment](/v2/environments/PatchEnv): Partially updates an environment. Only the provided fields will be modified.

  - **Keys**
  - [List account event keys](/v2/keys/FetchAccountEventKeys): Lists event keys for a specific account, optionally filtered by environment. If the environment header isn't specified, this returns the default production environment's keys.
  - [List account signing keys](/v2/keys/FetchAccountSigningKeys): Lists signing keys for a specific account, optionally filtered by environment.  If the environment header isn't specified, this returns the default production environment's keys.

  - **Partner API**
  - [List partner accounts](/v2/partner-api/FetchPartnerAccounts): Lists sub-accounts (if you have partner access)
  - [Create partner account](/v2/partner-api/CreatePartnerAccount): Creates a sub-account (if you have partner access)

  - **Runs**
  - [Get function run](/v2/runs/GetFunctionRun): Fetches the canonical run summary for a single function run
  - [Get function trace](/v2/runs/GetFunctionTrace): Fetches the trace tree for a single function run