Get all workflow actions | Solvimon

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

[
  {
    "workflow_id": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a",
    "type": "SEND_EMAIL_TO_CUSTOMER",
    "status": "ACTIVE",
    "object_type": "workflow_action",
    "id": "a3f1c9d2-7b4e-4f8a-9d3e-2b5f6c7d8e9f",
    "description": "Send invoice email to customer upon order completion",
    "created_at": "2024-05-10T09:15:00Z",
    "updated_at": "2024-05-15T11:20:00Z",
    "send_email_to_customer": {
      "integration_id": "email-integration-12345",
      "template_name": "invoice_notification",
      "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": false
      }
    }
  }
]

Returns all workflow actions for the platform. Actions define what happens when a workflow trigger executes. Requires the WORKFLOW_ACTION.VIEW 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

Query parameters

limitintegerOptional

The amount of records shown in the list

pageintegerOptional

The page which is going to be shown

order_bystringOptional

The parameter by which the response is ordered.

order_directionstringOptional

The order direction by which the response is ordered.

Response

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

Query parameters

Response

Errors