Sign in
Functions

Invoke function

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

post/apps/{appId}/functions/{functionId}/invoke

Request

  • Base URL: https://api.inngest.com/v2
  • URL: https://api.inngest.com/v2/apps/{appId}/functions/{functionId}/invoke
  • Auth: API key in header Authorization

Path parameters

appIdstring required

The ID of the app containing the function

functionIdstring required

The ID of the function to invoke

Request body

dataobject

JSON object containing the input data for the function

idempotencyKeystring

Optional idempotency key to handle duplicate requests within a given idempotency period.

Example request

{
  "data": {
    "message": "Hello, World!"
  },
  "idempotencyKey": "user-action-123"
}

Response

Function invoked asynchronously

Example response

{
  "data": {
    "result": "{\"success\": true, \"data\": \"Hello, World!\"}",
    "runId": "01hp1zx8m3ng9vp6qn0xk7j4cy"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.