Create a workflow action

POST

/v:version/workflow-actions

POST

/v:version/workflow-actions

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

1 {
2   "object_type": "string",
3   "id": "string",
4   "workflow_id": "string",
5   "type": "SEND_EMAIL_TO_CUSTOMER",
6   "description": "string",
7   "status": "ACTIVE",
8   "created_at": "string",
9   "updated_at": "string",
10   "send_email_to_customer": {
11     "integration_id": "string",
12     "subject": "string",
13     "from": {
14       "name": "string",
15       "email": "string"
16     },
17     "reply_to": {
18       "name": "string",
19       "email": "string"
20     },
21     "support_email": "string",
22     "cc_recipients": [
23       "string"
24     ],
25     "bcc_recipients": [
26       "string"
27     ],
28     "template_name": "string",
29     "localize_template_names": true,
30     "variant": "INVOICE",
31     "date_format": "string",
32     "invoice": {
33       "type": "TO_FINAL",
34       "include_pdf": true,
35       "include_payment_link": true,
36       "include_customer_contacts_as_cc": true
37     },
38     "payment": {
39       "include_customer_contacts_as_cc": true
40     },
41     "pricing_plan_subscription": {
42       "include_customer_contacts_as_cc": true
43     }
44   },
45   "export_to_erp": {
46     "executor": "THIRD_PARTY"
47   },
48   "send_webhook": {
49     "webhook_id": "string"
50   }
51 }

Creates a workflow action linked to an existing workflow. The action payload must match the selected action type. Requires the WORKFLOW_ACTION.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.

workflow_idstringOptional

Workflow that owns this action.

typeenumOptional

Action type that selects the matching action configuration.

descriptionstring or nullOptionalformat: "^.*$"0-256 characters

Description of what this action does.

statusenumOptional

Status of the action.

send_email_to_customerobjectOptional

Email action configuration used to send an email to the customer.

export_to_erpobjectOptional

Export-to-ERP action configuration. Used when type is EXPORT_TO_ERP.

send_webhookobjectOptional

Send-webhook action configuration. Used when type is SEND_WEBHOOK.

Response

Created

object_typestring or nullOptionalRead-only

idstring or nullOptionalRead-only