POST v1/Webhook?instance={instance}&projectid={projectid}&jobid={jobid}

Executes a Job in asynchronous mode. The response will be returned immediately. You can check the results via the Results API. The BODY of the request will be passed in as the Job Argument.

Request Information

URI Parameters

Name	Description	Type	Additional information
instance	The name of your StarfishETL instance. This can be found on the Setup -> Account tab within the Designer.	string	Required
projectid	ID of the Project which holds the Job you want to run.	string	Required
jobid	ID of the Job you want to run. This can be found on the "Job Settings" tab within the Designer.	string	Required

Body Parameters

None.

Response Information

Resource Description

execJobAsyncResponse

Name	Description	Type	Additional information
runID	GUID-formatted ID which was supplied by the user at the start	string	None.
started	Result status after run. Typically "Started" or "Failed".	boolean	None.
error	Error message that may have occurred while trying to start the job.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "runID": "sample string 1",
  "started": true,
  "error": "sample string 3"
}

application/xml, text/xml

Sample:

<execJobAsyncResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StarfishAPI.Controllers">
  <error>sample string 3</error>
  <runID>sample string 1</runID>
  <started>true</started>
</execJobAsyncResponse>