Workflows

Retrieve a workflow

Fetches details of a specific workflow by its unique identifier workflowId

get/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

Query parameters

environmentIdstring

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.