Inngest

App · 20 actions

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

Actions

ActionWhat it does
Cancel function runCancels an in-progress function run
Get accountReturns the account for the authenticated user
Get appFetches details for a single app, including sync metadata and function count
Get app syncGets an app sync.
Get eventGets an event by its internal ID.
Get functionFetches function configuration and status details for a function within an app
Get function runFetches the canonical run summary for a single function run
Get function traceFetches the trace tree for a single function run
Invoke functionInvokes a function, executing the function either asynchronously or synchronously based on the mode parameter in the request body
List app syncsLists app syncs newest first.
List appsLists active apps in the authenticated environment.
List event runsLists function runs triggered by a specific event
List eventsLists events in descending internal-ID order, excluding internal inngest/ events.
List function runsLists runs for one function in the authenticated environment
List functionsLists function configuration and status details for an app
List runsLists runs in the authenticated environment, optionally filtered by app and function IDs
Pause functionPauses a function.
Rerun functionCreates a new run using the original run's triggering event data
Resume functionResumes a paused function.
Send eventSend one event to your Inngest environment.

Cancel function run

Cancels an in-progress function run

Inputs

Runrun_idtextRequired
Run ID.

Outputs

dataobject
Result.
Example output
{
  "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

dataobject
Result.
Example output
{
  "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

Appapp_idtextRequired
The user-defined app ID

Outputs

dataobject
Result.
Example output
{
  "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

Appapp_idtextRequired
The user-defined app ID
Syncsync_idtextRequired
Sync UUID

Outputs

dataobject
Result.
Example output
{
  "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 IDevent_idtextRequired
Internal event ULID, also used by GetEventRuns.
Includeincludelist
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

dataobject
Result.
Example output
{
  "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

Appapp_idtextRequired
App ID.
Functionfunction_idtextRequired
Function ID.

Outputs

dataobject
Result.
Example output
{
  "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

Runrun_idtextRequired
Run ID.
Includeincludelist
Optional run expansions selected by their lowerCamelCase API names.One or more of: output.

Outputs

dataobject
Result.
Example output
{
  "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

Runrun_idtextRequired
Run ID.
Includeincludelist
Optional trace expansions selected by their lowerCamelCase API names.One or more of: output.

Outputs

dataobject
Result.
Example output
{
  "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

Appapp_idtextRequired
The ID of the app containing the function
Functionfunction_idtextRequired
The ID of the function to invoke
Datadataobject
JSON object containing the input data for the function
Idempotency keyidempotency_keytext
Optional idempotency key to handle duplicate requests within a given idempotency period.

Outputs

dataobject
Result.
Example output
{
  "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

Appapp_idtextRequired
The user-defined app ID
Cursorcursortext
Pagination cursor from previous response: the UUID of the last returned sync
Limitlimitnumber
Number of syncs to return per page: 1-100; 0 or omitted uses 20Default: 20.

Outputs

dataobject
Result.
Example output
{
  "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

Cursorcursortext
Pagination cursor from previous response
Limitlimitnumber
Number of apps to return per page (min: 1, max: 100)Default: 20.
Archivedarchivedtrue/false
Whether to return archived apps instead of active appsDefault: false.

Outputs

dataobject
Result.
Example output
{
  "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 IDevent_idtextRequired
Event ID.
Cursorcursortext
Pagination cursor from previous response
Limitlimitnumber
Number of runs to return per page (min: 1, max: 40)Default: 20.
Includeincludelist
Optional run expansions selected by their lowerCamelCase API names.One or more of: output.

Outputs

dataobject
Result.
Example output
{
  "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

Cursorcursortext
ID of the last returned event from the previous response. Reuse the same filters and metadata.timeRange on subsequent pages.
Limitlimitnumber
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 timestart_timedate 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 timeend_timedate 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.
Namenamelist
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.
Includeincludelist
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

dataobject
Result.
Example output
{
  "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

Appapp_idtextRequired
App ID.
Functionfunction_idtextRequired
Function ID.
Cursorcursortext
Pagination cursor from previous response
Limitlimitnumber
Number of runs to return per page (min: 1, max: 100)Default: 20.
Start timestart_timedate and time
Inclusive start of the run time range
End timeend_timedate and time
Inclusive end of the run time range
Time fieldtime_fieldtext
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.
Statusstatuslist
Statuses to include, using response status values such as COMPLETED, FAILED, RUNNING, QUEUED, CANCELLED, SKIPPED, or PAUSED
Is deferredis_deferredtrue/false
Whether to include only deferred or non-deferred runs
Orderordertext
Sort direction. Accepts ASC or DESC.Default: DESC.
Queryquerytext
CEL expression used to filter runs by event, output, or error data
Includeincludelist
Optional run expansions selected by their lowerCamelCase API names.One or more of: output, deferredFrom.

Outputs

dataobject
Result.
Example output
{
  "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

Appapp_idtextRequired
App ID.
Cursorcursortext
Pagination cursor from previous response
Limitlimitnumber
Number of functions to return per page (min: 1, max: 100)Default: 20.

Outputs

dataobject
Result.
Example output
{
  "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

Cursorcursortext
Pagination cursor from previous response
Limitlimitnumber
Number of runs to return per page (min: 1, max: 100)Default: 20.
Start timestart_timedate and time
Inclusive start of the run time range
End timeend_timedate and time
Inclusive end of the run time range
Time fieldtime_fieldtext
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.
Statusstatuslist
Statuses to include, using response status values such as COMPLETED, FAILED, RUNNING, QUEUED, CANCELLED, SKIPPED, or PAUSED
Appapp_idlist
App IDs to include
Function IDfunction_idlist
Function IDs to include
Is deferredis_deferredtrue/false
Whether to include only deferred or non-deferred runs
Orderordertext
Sort direction. Accepts ASC or DESC.Default: DESC.
Queryquerytext
CEL expression used to filter runs by event, output, or error data
Includeincludelist
Optional run expansions selected by their lowerCamelCase API names.One or more of: output, deferredFrom.

Outputs

dataobject
Result.
Example output
{
  "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

Appapp_idtextRequired
App ID.
Functionfunction_idtextRequired
Function ID.

Outputs

dataobject
Result.
Example output
{
  "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

Runrun_idtextRequired
Run ID.
From stepfrom_stepobject
From step.

Outputs

dataobject
Result.
Example output
{
  "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

Appapp_idtextRequired
App ID.
Functionfunction_idtextRequired
Function ID.

Outputs

dataobject
Result.
Example output
{
  "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

Datadataobject
JSON object containing event data
IDidtext
Optional event ID used for idempotency when scheduling function runs
NamenametextRequired
Event name
Event timeoccurred_atdate and time
Optional event timestamp as Unix time in milliseconds. Defaults to the current time.
Useruserobject
Deprecated user data. Put user data in the data field instead.

Outputs

dataobject
Result.
Example output
{
  "data": {
    "data": {
      "eventId": "example"
    },
    "metadata": {
      "cachedUntil": "example",
      "fetchedAt": "example",
      "timeRange": {
        "from": "example",
        "until": "example"
      }
    }
  }
}

On this page