Workflows

Update a workflow

Updates the details of an existing workflow, here workflowId is the identifier of the workflow

put/v2/workflows/{workflowId}

Request

  • Base URL: https://api.notifly.io
  • URL: https://api.notifly.io/v2/workflows/{workflowId}
  • Auth: API key in header Authorization

Path parameters

workflowIdstring required

Request body

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

workflowIdstring

Workflow ID (allowed only for code-first workflows)

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

Origin of the layout

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

Severity of the workflow

Example request

{
  "steps": [
    {
      "controlValues": {
        "skip": {
          "and": [
            {
              "==": [
                {
                  "var": "payload.tier"
                },
                "pro"
              ]
            },
            {
              "==": [
                {
                  "var": "subscriber.data.role"
                },
                "admin"
              ]
            },
            {
              ">": [
                {
                  "var": "payload.amount"
                },
                "4"
              ]
            }
          ]
        }
      }
    }
  ],
  "preferences": {
    "user": {
      "channels": {
        "email": {
          "enabled": true
        },
        "sms": {
          "enabled": false
        }
      }
    },
    "workflow": {
      "channels": {
        "email": {
          "enabled": true
        },
        "sms": {
          "enabled": false
        }
      }
    }
  }
}

Response

OK

Example response

{
  "data": {
    "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}}"
          }
        }
      }
    ],
    "preferences": {
      "user": {
        "channels": {
          "email": {
            "enabled": true
          },
          "sms": {
            "enabled": false
          }
        }
      },
      "default": {
        "channels": {
          "email": {
            "enabled": true
          },
          "sms": {
            "enabled": false
          }
        }
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.