{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Journey - Trigger Actions API API", "version": "1.0.0" }, "items": [ { "info": { "name": "Journey - Trigger Actions API", "type": "folder" }, "items": [ { "info": { "name": "Get all Journey Actions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "sortBy", "value": "updatedAt", "type": "query", "description": "Sort By Field" }, { "name": "sort", "value": "ASC", "type": "query", "description": "Sort direction" }, { "name": "page", "value": "0", "type": "query", "description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve. The page numbering starts with 0." }, { "name": "pageSize", "value": "10", "type": "query", "description": "Number of items to be displayed on a page." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get all Journey Actions in JDS. \n\nRole and Scope: Requires id full admin or any role with cjp:config_write or cjp:config_read scope." }, { "info": { "name": "Get all Journey Actions for a template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "templateId", "value": "56n3ugx44678998djs878", "type": "path", "description": "Template ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get all Journey Actions for a template in JDS. \n\nRole and Scope: It requires id full admin or any role with cjp:config_read or cjp:config_write scope." }, { "info": { "name": "Create a new Journey Action", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "templateId", "value": "56n3ugx44678998djs878", "type": "path", "description": "Template ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a new Journey Action in JDS. \n\n **Role and Scope**: It requires id full admin or any role with cjp:config_write scope.\n\n **Sample Input for Creating new Journey action**: \n ```\n {\n \"name\": \"Closed Queue Action\",\n \"cooldownPeriodInMinutes\": 1,\n \"rules\": {\n \"logic\": \"SINGLE\",\n \"condition\": \"Closed Queue,category,string,Value GTE 2\"\n },\n \"actionTriggers\": [\n {\n \"type\": \"Webhook\",\n \"webhookURL\": \"https://hooks.us.webexconnect.io/events/6M347NJ6\",\n" }, { "info": { "name": "Get specific Journey Action By Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-name/:actionName", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "templateId", "value": "56n3ugx44678998djs878", "type": "path", "description": "Template ID" }, { "name": "actionName", "value": "demo action", "type": "path", "description": "Action Name" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get specific Journey Action By Name in JDS. \n\nRole and Scope:It requires id full admin or any role with cjp:config_read or cjp:config_write scope." }, { "info": { "name": "Get specific Journey Action By ActionId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "templateId", "value": "56n3ugx44678998djs878", "type": "path", "description": "Template ID" }, { "name": "actionId", "value": "73n3ugx12678998djs878", "type": "path", "description": "Action ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get specific Journey Action By ActionId in JDS. \n\nRole and Scope: It requires id full admin role with cjp:config_read or cjp:config_write scope." }, { "info": { "name": "Update existing Journey Action", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "templateId", "value": "56n3ugx44678998djs878", "type": "path", "description": "Template ID" }, { "name": "actionId", "value": "73n3ugx12678998djs878", "type": "path", "description": "Action ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update existing Journey Action in JDS. \n\nRole and Scope: It requires id full admin or any role with cjp:config_write scope." }, { "info": { "name": "Delete Journey Action configuration By ActionId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "templateId", "value": "56n3ugx44678998djs878", "type": "path", "description": "Template ID" }, { "name": "actionId", "value": "73n3ugx12678998djs878", "type": "path", "description": "Action ID" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://webexapis.com/v1/authorize", "accessTokenUrl": "https://webexapis.com/v1/access_token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete Journey Action configuration By ActionId in JDS. \n\nRole and Scope: It requires id full admin role with cjp:config_write scope." } ] } ], "bundled": true }