{ "opencollection": "1.0.0", "info": { "name": "Novu Activity Workflows API", "version": "3.15.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Workflows", "type": "folder" }, "items": [ { "info": { "name": "Novu List All Workflows", "type": "http" }, "http": { "method": "GET", "url": "https://api.novu.co/v2/workflows", "params": [ { "name": "limit", "value": "10", "type": "query", "description": "Number of items to return per page" }, { "name": "offset", "value": "0", "type": "query", "description": "Number of items to skip before starting to return results" }, { "name": "orderDirection", "value": "", "type": "query", "description": "Direction of sorting" }, { "name": "orderBy", "value": "", "type": "query", "description": "Field to sort the results by" }, { "name": "query", "value": "", "type": "query", "description": "Search query to filter workflows" }, { "name": "tags", "value": "", "type": "query", "description": "Filter workflows by tags" }, { "name": "status", "value": "", "type": "query", "description": "Filter workflows by status" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves a list of workflows with optional filtering and pagination" }, { "info": { "name": "Novu Create a Workflow", "type": "http" }, "http": { "method": "POST", "url": "https://api.novu.co/v2/workflows", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Creates a new workflow in the Novu Cloud environment" }, { "info": { "name": "Novu Sync a Workflow", "type": "http" }, "http": { "method": "PUT", "url": "https://api.novu.co/v2/workflows/:workflowId/sync", "params": [ { "name": "workflowId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Synchronizes a workflow to the target environment" }, { "info": { "name": "Novu Retrieve a Workflow", "type": "http" }, "http": { "method": "GET", "url": "https://api.novu.co/v2/workflows/:workflowId", "params": [ { "name": "workflowId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Fetches details of a specific workflow by its unique identifier **workflowId**" }, { "info": { "name": "Novu Update a Workflow", "type": "http" }, "http": { "method": "PUT", "url": "https://api.novu.co/v2/workflows/:workflowId", "params": [ { "name": "workflowId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Updates the details of an existing workflow, here **workflowId** is the identifier of the workflow" }, { "info": { "name": "Novu Update a Workflow", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.novu.co/v2/workflows/:workflowId", "params": [ { "name": "workflowId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Partially updates a workflow by its unique identifier **workflowId**" }, { "info": { "name": "Novu Delete a Workflow", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.novu.co/v2/workflows/:workflowId", "params": [ { "name": "workflowId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Removes a specific workflow by its unique identifier **workflowId**" }, { "info": { "name": "Novu Generate a Step Preview", "type": "http" }, "http": { "method": "POST", "url": "https://api.novu.co/v2/workflows/:workflowId/step/:stepId/preview", "params": [ { "name": "workflowId", "value": "", "type": "path" }, { "name": "stepId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Generates a preview for a specific workflow step by its unique identifier **stepId**" }, { "info": { "name": "Novu Retrieve Workflow Step", "type": "http" }, "http": { "method": "GET", "url": "https://api.novu.co/v2/workflows/:workflowId/steps/:stepId", "params": [ { "name": "workflowId", "value": "", "type": "path" }, { "name": "stepId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves data for a specific step in a workflow" } ] } ], "bundled": true }