workflow (1.3.0)

Download OpenAPI specification:Download

Workflow Microservice

Authentication

ApiKeyAuth

Security Scheme Type API Key
Header parameter name: X-API-Key

cors

appLogOptions

CORS support

Responses

emailMessageOptions

CORS support

Responses

outgoingEmailMessageOptions

CORS support

Responses

AppLog

Post app log messages

Insert app log messages into workflow storage

Authorizations:
Request Body schema: application/json

An array of new AppLog records

Array of objects (AppLog)
object (RequestMeta)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

EmailMessage

Get email messages from data store

Retrieves email messages from workflow storage

Authorizations:
query Parameters
emailMessageId
string

Email Message ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

OutgoingEmailMessage

Add new email messages to the outgoing queue

Insert new email messages into workflow storage

Authorizations:
Request Body schema: application/json

An array of new Outgoing Email Message records

Array of objects (OutgoingEmailMessage)
object (RequestMeta)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}