Initialise a workflow

POST

/v:version/workflows/init

POST

/v:version/workflows/init

$ curl -X POST https://test.api.solvimon.com/v1/workflows/init \
>      -H "X-API-KEY: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "workflow": {
3     "object_type": "string",
4     "id": "string",
5     "name": "string",
6     "description": "string",
7     "type": "INVOICE",
8     "reference": "string",
9     "status": "ACTIVE",
10     "created_at": "string",
11     "updated_at": "string",
12     "conditions": {
13       "type": "GROUP",
14       "group": {
15         "operator": "AND",
16         "operands": [
17           {}
18         ]
19       },
20       "comparison": {
21         "field": "string",
22         "comparator": "EQUALS",
23         "value": "string"
24       }
25     },
26     "customer_ids": [
27       "string"
28     ],
29     "invoice": {
30       "variant": "TO_FINAL",
31       "overdue": {
32         "periods": [
33           {
34             "type": "DAY",
35             "value": 1
36           }
37         ]
38       },
39       "upcoming_payment": {
40         "periods": [
41           {
42             "type": "DAY",
43             "value": 1
44           }
45         ]
46       }
47     },
48     "payment": {
49       "variant": "FAILED_PAYMENT"
50     },
51     "pricing_plan_subscription": {
52       "variant": "FREE_TRIAL_REMINDER",
53       "reminder_periods": [
54         {
55           "type": "DAY",
56           "value": 1
57         }
58       ]
59     },
60     "wallet": {
61       "variant": "WALLET_BALANCE",
62       "wallet_balance": {
63         "wallet_type_id": "string",
64         "comparator": "EQUALS",
65         "threshold": {
66           "percentage": "string",
67           "amount": {
68             "quantity": "string",
69             "currency": "AED"
70           },
71           "credits": {
72             "quantity": "string",
73             "credit_type_id": "string"
74           }
75         }
76       }
77     },
78     "usage": {
79       "variant": "USAGE_LIMIT",
80       "meter_value_calculation_id": "string",
81       "thresholds": [
82         {
83           "percentage": "string",
84           "number": "string",
85           "amount": {
86             "quantity": "string",
87             "currency": "AED"
88           },
89           "credits": {
90             "quantity": "string",
91             "credit_type_id": "string"
92           }
93         }
94       ]
95     }
96   },
97   "actions": [
98     {
99       "object_type": "string",
100       "id": "string",
101       "workflow_id": "string",
102       "type": "SEND_EMAIL_TO_CUSTOMER",
103       "description": "string",
104       "status": "ACTIVE",
105       "created_at": "string",
106       "updated_at": "string",
107       "send_email_to_customer": {
108         "integration_id": "string",
109         "subject": "string",
110         "from": {
111           "name": "string",
112           "email": "string"
113         },
114         "reply_to": {
115           "name": "string",
116           "email": "string"
117         },
118         "support_email": "string",
119         "cc_recipients": [
120           "string"
121         ],
122         "bcc_recipients": [
123           "string"
124         ],
125         "template_name": "string",
126         "localize_template_names": true,
127         "variant": "INVOICE",
128         "date_format": "string",
129         "invoice": {
130           "type": "TO_FINAL",
131           "include_pdf": true,
132           "include_payment_link": true,
133           "include_customer_contacts_as_cc": true
134         },
135         "payment": {
136           "include_customer_contacts_as_cc": true
137         },
138         "pricing_plan_subscription": {
139           "include_customer_contacts_as_cc": true
140         }
141       },
142       "export_to_erp": {
143         "executor": "THIRD_PARTY"
144       },
145       "send_webhook": {
146         "webhook_id": "string"
147       }
148     }
149   ]
150 }

Ensures a workflow and its actions exist. The workflow is matched by its reference; when it already exists it and its actions are left untouched. Returns the composed workflow with its actions. Requires the WORKFLOW.CREATE permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

Request

This endpoint expects an object.

workflowobjectOptional

The workflow to ensure. Matched by its reference.

actionslist of objects or nullOptional

The workflow actions to create together with the workflow when it does not yet exist.

Response

workflowobjectOptional

The workflow to ensure. Matched by its reference.

actionslist of objects or nullOptional

The workflow actions to create together with the workflow when it does not yet exist.

Errors

401

Unauthorized Error

403

Forbidden Error

Authentication

Path parameters

Headers

Request

Response

Errors