Workflows

Een Workflow vertegenwoordigt de fasen van een automatisering die, in zijn eenvoudigste vorm, brongegevens omzet in uitvoerdocumenten.

Fields

Field	Type	Editable	Description
id	String	false	De unieke ID van de workflow. Wordt gebruikt om naar de workflow te verwijzen in alle verzoeken.
name	String	true	De naam van de workflow.
color	String	true	De kleur van het workflowpictogram in Portant Workflow als een hex-tekenreeks, voorafgegaan door #.
icon	String	true	De naam van het pictogram dat wordt gebruikt in Portant Workflow.
status	String	false	De huidige status van de workflow. Een van: - "COMPLETE": de workflow kan worden uitgevoerd. - "INCOMPLETE": de workflow heeft meer configuratie nodig voordat deze kan worden uitgevoerd. - "ARCHIVED": de workflow is niet langer bruikbaar.
autoCreate	Boolean	false	Wanneer true, luistert de workflow naar brongebeurtenissen en maakt elke keer dat er een binnenkomt een nieuwe automatisering aan.
owner	Owner	false	De eigenaar van deze workflow.
team	Team	false	Het team waartoe deze workflow behoort.
source	Source	false	De gegevensbron voor deze workflow.
documents	Document	false	De sjabloondocumenten voor deze workflow.
outgoingWebhook	Outgoing Webhook	false	De uitgaande Webhook van deze workflow, gebruikt om te luisteren naar automatiseringsgebeurtenissen.
createdByApi	Boolean	false	True wanneer de workflow is aangemaakt via de Developer API.
createdAt	String	false	Een ISO 8601-tijdstempel voor het moment waarop de workflow is aangemaakt.
updatedAt	String	false	Een ISO 8601-tijdstempel voor het moment waarop de workflow voor het laatst is bijgewerkt.

Example

```json
{
    "id": "wkf_kGQK9PBWDT1JCr",
    "name": "Invoice Workflow",
    "icon": "DocumentText",
    "color": "#cccccc",
    "status": "COMPLETE",
    "autoCreate": true,
    "owner": {
        "id": "usr_DsH4TGYXs4XPpB",
        "name": "Blake Lockley",
        "email": "blake@portant.co"
    },
    "team": null,
    "source": {
        "id": "src_NZHJYjlgrvklHb",
        "sourceType": "WEBHOOK",
        "sourceFields": [
            "Order Number",
            "LineItem.Name",
            "LineItem.Price",
        ],
        "webhookUrl": "https://webhooks.portant.co/50c7912b14c7acbe9df32521ec60a27c"
    },
    "documents": [
        {
            "id": "doc_5LGGqC5S78RNS0",
            "documentType": "GOOGLE_DOCS",
            "file": {
                "id": "1uNfBHAKhcgRsiftb7xRpTJRS0k9LY1iX1gUnTOE0zU4",
                "name": "Complete Workflow Please - [Template]",
                "url": "https://docs.google.com/document/d/1uNfBHAKhcgRsiftb7xRpTJRS0k9LY1iX1gUnTOE0zU4/edit?usp=drivesdk",
                "mimeType": "application/vnd.google-apps.document"
            },
            "outputName": "Document for {{First Name}}",
            "pdfPassword": "jeRe/\/\eyWaZH3re",
            "enablePdfPassword": true,
            "enablePdfPreventCopy": false,
            "previewUrl": "https://preview.portant.co/doc_5LGGqC5S78RNS0"
        }
    ],
    "outgoingWebhook": {
        "id": "owc_XY1Ys4gqrpX8cp",
        "webhookUrl": "https://webhook.site/d22c56ab-40ac-4f9a-93ef-02520235c0da"
    },
    "createdByApi": true,
    "createdAt": "2024-08-12T16:20:44.346666+10:00",
    "updatedAt": "2024-08-12T16:20:48.408357+10:00"
}
```

Endpoints

List all workflows

GET /workflows/

Geef elke Workflow terug die eigendom is van, of gedeeld is met, het team van de API-gebruiker.

Responses

Status	Body
200 OK	Array<Workflow>
403 Unauthorised	Error

Create a workflow

POST /workflows/

Maak een nieuwe workflow aan.

Request

Een gedeeltelijk Workflow-object als JSON. Het enige verplichte veld is name.

{
    name: "A simple workflow"
}

U kunt ook een volledige workflow in één POST aanmaken door de optionele subcomponenten en hun verplichte velden op te nemen.

Velden met het achtervoegsel ? zijn optioneel.

{
    name: "A complete Workflow from Scratch",
    color?: "#...",
    icon?: "...",
    source?: {
        "sourceFields": ["Field Name 1", "Field Name 2"]
    },
    document?: {
        fileId: "<google file id>"
    },
    outgoingWebhook?: {
        webhookUrl: "<webhook url for event listening>"
    }
}

Responses (Reacties)

Status	Body
201 Created	Workflow
400 Bad Request	Error
403 Unauthorised	Error

Een workflow ophalen

GET /workflows/<wkf_id>/

Haal een specifieke workflow op aan de hand van het ID.

Responses (Reacties)

Status	Body
200 OK	Workflow
403 Unauthorised	Error
404 Not Found	Error

Een workflow bijwerken

PATCH /workflows/<wkf_id>/

Werk een specifieke workflow bij aan de hand van het ID.

Request (Verzoek)

Een gedeeltelijk Workflow-object als JSON. Velden met het achtervoegsel ? zijn optioneel.

{
    name?: "...",
    color?: "#...",
    icon?: "..."
 }

Response (Reactie)

Status	Body
200 OK	Workflow
400 Bad Request	Error
403 Unauthorised	Error
404 Not Found	Error

Een workflow verwijderen

DELETE /workflows/<wkf_id>/

Verwijder een specifieke workflow aan de hand van het ID. De workflow wordt niet daadwerkelijk verwijderd. De status wordt ingesteld op "ARCHIVED". Gearchiveerde workflows kunnen worden hersteld door contact op te nemen met het klantenserviceteam.

Response (Reactie)

Status	Body
204 No Content
400 Bad Request	Error
403 Unauthorised	Error
404 Not Found	Error