Workflows

Synchronizes a workflow to the target environment

put/v2/workflows/{workflowId}/sync

Request

  • Base URL
    https://api.novu.co
  • Auth
    API key in header Authorization

Path parameters

workflowIdstring required

Headers

idempotency-keystring

A header for idempotency purposes

Request body

targetEnvironmentIdstring required

Target environment identifier to sync the workflow to

Response

OK

namestring required

Name of the workflow

descriptionstring

Description of the workflow

tagsstring[]

Tags associated with the workflow

activeboolean

Whether the workflow is active

validatePayloadboolean

Enable or disable payload schema validation

payloadSchemaobject nullable

The payload JSON Schema for the workflow

isTranslationEnabledboolean

Enable or disable translations for this workflow

_idstring required

Database identifier of the workflow

workflowIdstring required

Workflow identifier

slugstring required

Slug of the workflow

updatedAtstring required

Last updated timestamp

createdAtstring required

Creation timestamp

lastPublishedAtstring nullable

Timestamp of the last workflow publication

origin'novu-cloud' | 'novu-cloud-v1' | 'external' required

Origin of the workflow

status'ACTIVE' | 'INACTIVE' | 'ERROR' required

Status of the workflow

issuesobject

Runtime issues for workflow creation and update

lastTriggeredAtstring nullable

Timestamp of the last workflow trigger

payloadExampleobject nullable

Generated payload example based on the payload schema

severity'high' | 'medium' | 'low' | 'none' required

Override the severity of the workflow

Example response

{
  "steps": [
    {
      "controls": {
        "values": {
          "skip": {
            "and": [
              {
                "==": [
                  {
                    "var": "payload.tier"
                  },
                  "pro"
                ]
              },
              {
                "==": [
                  {
                    "var": "subscriber.data.role"
                  },
                  "admin"
                ]
              },
              {
                ">": [
                  {
                    "var": "payload.amount"
                  },
                  "4"
                ]
              }
            ]
          }
        }
      },
      "controlValues": {
        "skip": {
          "and": [
            {
              "==": [
                {
                  "var": "payload.tier"
                },
                "pro"
              ]
            },
            {
              "==": [
                {
                  "var": "subscriber.data.role"
                },
                "admin"
              ]
            },
            {
              ">": [
                {
                  "var": "payload.amount"
                },
                "4"
              ]
            }
          ]
        }
      },
      "providerOverrides": {
        "slack": {
          "text": "{{payload.title}}",
          "blocks": [
            {
              "type": "divider"
            }
          ]
        },
        "whatsapp-business": {
          "type": "text",
          "text": {
            "body": "{{payload.title}}"
          }
        },
        "pagerduty": {
          "severity": "warning",
          "source": "novu",
          "summary": "{{payload.title}}"
        }
      },
      "integrationOverrides": {
        "tool-webhook": {
          "prod-alerts": {
            "alert_type": "incident"
          },
          "staging-alerts": {
            "alert_type": "test"
          }
        }
      }
    }
  ],
  "preferences": {
    "user": {
      "channels": {
        "email": {
          "enabled": true
        },
        "sms": {
          "enabled": false
        }
      }
    },
    "default": {
      "channels": {
        "email": {
          "enabled": true
        },
        "sms": {
          "enabled": false
        }
      }
    }
  }
}

Changes

    • breaking

      the response's property type changed from no type to object for status

    • breaking

      the response's property type changed from no type to object for status

    • breaking

      the ///// response's property type changed from no type to object for status

    • breaking

      the response's property type changed from no type to object for status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status