Skip to main content
POST
/
functions
/
dryruns
Dry run a function
curl --request POST \
  --url https://api.nango.dev/functions/dryruns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration_id": "<string>",
  "code": "<string>",
  "connection_id": "<string>",
  "input": "<unknown>",
  "metadata": {},
  "checkpoint": {},
  "last_sync_date": "2023-11-07T05:31:56Z"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z"
}
Requires an API key with the environment:functions:dryrun scope. Learn more about API key scopes.
Starts an asynchronous dry run for TypeScript function source code against a connection without deploying it.

Authorizations

​
Authorization
string
header
required

The secret key from your Nango environment.

Body

application/json
​
integration_id
string
required

The integration ID (unique_key) that you created in Nango.

​
function_type
enum<string>
required
Available options:
action,
sync
​
code
string
required

The TypeScript source code for the function.

Minimum string length: 1
​
connection_id
string
required

The connection ID to use for the dry run.

​
input
any

Optional JSON input payload passed to the function.

​
metadata
object

Optional metadata available to the function during the dry run.

​
checkpoint
object

Optional checkpoint payload available to sync functions during the dry run.

​
last_sync_date
string<date-time>

Optional last sync date available to sync functions during the dry run.

Response

Successfully started the dry run.

​
id
string<uuid>
required
​
status
enum<string>
required
Available options:
waiting,
running
​
created_at
string<date-time>
required