Run/schedule a connection.

post https://api.gigasheet.com/connectors/create

Creates (if needed) and runs a connection with the given configuration. If a schedule is passed, the connector will be run on that schedule. (If there was an existing schedule, it will be overwritten.)

Body Params

Request fields

connectionId

string

connection id for the request -- if not provided, connection will be created

connectionName

string

connection name for the request -- if not provided, "Source Type timestamp" will be set

jobParams

object

parameters for the scheduled job -- expected to be keyed by the job type

obfuscatedUser

string

obfuscated user. Generally auth0 id.

params

string

configuration parameters

runNow

boolean

run the request immediately (only used when schedule is present, otherwise always runs)

schedule

object

schedule for requests

skipNotification

boolean

skip sending notifications, will send notifications by the default

source

string

name of source

user

string

user id for user performing action.

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.gigasheet.com/connectors/create \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

401Unauthorized

403Forbidden

500Internal Server Error