Source

Overview

The Source resources represents the origin data will come from that will be used within the automation. For workflows created via the Developer API the source will always be a Webhook source.

Fields

Field	Type	Description
id	String	The ID of the source.
sourceType	String	The type of source for the workflow. For workflows created by the developer API this will always have the value of "WEBHOOK".
sourceFields	Array<String>	The names of source fields used in this workflow. These can be provided upon creation of a workflow if known in advance. Otherwise these fields will reflect the keys of the last webhook event received by this workflow. Nested fields will be represented with a `.` between the parent and child fields.
webhookUrl	String	The webhook address of the workflow source. This is the url that source data is POST'ed to in order to initiate an automation.

Example

{
    "id": "src_NZHJYjlgrvklHb",
    "sourceType": "WEBHOOK",
    "sourceFields": [
        "Order Number",
        "LineItem.Name",
        "LineItem.Price",
    ],
    "webhookUrl": "https://webhooks.portant.co/50c7912b14c7acbe9df32521ec60a27c"
},

Endpoints

Get a Source

GET /workflows/<wkf_id>/source/

Retrieve the source of the specific workflow as specified by the id.

Responses

Status	Body
200 OK	Source
403 Unauthorised	Error