Fetch workflow definition

Retrieves a workflow definition by key

get/workflows/*

Request

Base URL
https://api.magicbell.com/v2
Auth
none declared
TypeScript
https://skmtc.dev/magicbell/apis/magicbell-api/docs/workflows/*/get.ts
A function with typed inputs. Its response is checked against the schema.

Response

OK

disabledboolean

When true, prevents the workflow from being triggered.

keystring required

Unique identifier for this workflow definition.

Example response

{
  "key": "project",
  "steps": [
    {
      "command": "broadcast",
      "input": {
        "channel": "in_app"
      }
    },
    {
      "command": "broadcast",
      "if": "{{data.paying}} == true",
      "input": {
        "channel": "email"
      }
    }
  ]
}

Changes

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