Source

The Source represents where a workflow's data comes from. For workflows created via the Developer API, the source is always a Webhook source.

Fields

Field	Type	Description
id	String	The ID of the source.
sourceType	String	The source type. For workflows created by the Developer API this is always `"WEBHOOK"`.
sourceFields	Array<String>	The names of source fields used in this workflow. You can supply these when you create the workflow if you know them ahead of time. Otherwise they reflect the keys of the last webhook event the workflow received. Nested fields are represented with a `.` between the parent and child fields.
webhookUrl	String	The webhook address of the workflow source. POST source data here to start 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 for a specific workflow.

Responses

Status	Body
200 OK	Source
403 Unauthorised	Error