Create a workflow action | Solvimon

curl -X POST https://test.api.solvimon.com/v1/workflow-actions \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "workflow_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "type": "SEND_EMAIL_TO_CUSTOMER",
  "status": "ACTIVE"
}'

{
  "workflow_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "type": "SEND_EMAIL_TO_CUSTOMER",
  "status": "ACTIVE",
  "object_type": "workflow_action",
  "id": "f1234567-89ab-4cde-9012-3456789abcde",
  "description": "Send invoice email to customer upon order completion",
  "created_at": "2024-06-01T10:15:30Z",
  "updated_at": "2024-06-10T12:00:00Z",
  "send_email_to_customer": {
    "integration_id": "email-integration-9876",
    "template_name": "invoice_template_v2",
    "variant": "INVOICE",
    "subject": "Your Invoice from Solvimon",
    "from": {
      "email": "billing@solvimon.com",
      "name": "Solvimon Billing"
    },
    "reply_to": {
      "email": "support@solvimon.com",
      "name": "Customer Support"
    },
    "cc_recipients": [
      "accounting@solvimon.com"
    ],
    "bcc_recipients": [
      "audit@solvimon.com"
    ],
    "invoice": {
      "include_pdf": true,
      "include_payment_link": true,
      "include_customer_contacts_as_cc": true
    },
    "payment": {
      "include_customer_contacts_as_cc": true
    }
  }
}

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_idstringRequired

Workflow that owns this action.

typeenumRequired

Action type that selects the matching action configuration.

Allowed values:

statusenumRequired

Status of the action.

Allowed values:

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

Description of what this action does.

send_email_to_customerobjectOptional

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

Response

Created

workflow_idstring

Workflow that owns this action.

typeenum

Action type that selects the matching action configuration.

Allowed values:

statusenum

Status of the action.

Allowed values:

object_typestring or nullRead-only

idstring or nullRead-only

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

Description of what this action does.

created_atstring or nullRead-only

Date time when the action was created.

updated_atstring or nullRead-only

Date time when the action was last updated.

send_email_to_customerobject

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

Errors

401

Unauthorized Error

403

Forbidden Error

Authentication

Path parameters

Headers

Request

Response

Errors