Deprecated. This function is being discontinued in the upcoming months. We are working to provide alternatives, and we'll provide timely updates before implementing any changes. We understand that this transition might present challenges, and we appreciate your patience and understanding.
Creates a new workflow.
The createWorkflow() function returns a Promise that resolves to the created workflow
ID.
function createWorkflow(workflowInfo: CreateWorkflowRequest): Promise<string>;Workflow to create.
import { Permissions, webMethod } from "wix-web-module";
import { workflows } from "wix-crm-backend";
export const createWorkflow = webMethod(Permissions.Anyone, () => {
return workflows.createWorkflow({
name: "My Workflow",
description: "The best workflow!",
});
});
// Returns a promise that resolves to:
// "3c9683ea-f6cc-470b-b0d1-2eb6b8cea912"Deprecated. This function is being discontinued in the upcoming months. We are working to provide alternatives, and we'll provide timely updates before implementing any changes. We understand that this transition might present challenges, and we appreciate your patience and understanding.
Deletes a workflow card by ID.
The deleteCard() function returns a Promise when the specified card
has been deleted.
This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflow API, see Retrieving IDs.
function deleteCard(cardId: string): Promise<void>;ID of the card to delete.
import { Permissions, webMethod } from "wix-web-module";
import { workflows } from "wix-crm-backend";
export const deleteCard = webMethod(Permissions.Anyone, (cardId) => {
return workflows.deleteCard(cardId);
});
// Returns a promise that resolves to void.Deprecated. This function is being discontinued in the upcoming months. We are working to provide alternatives, and we'll provide timely updates before implementing any changes. We understand that this transition might present challenges, and we appreciate your patience and understanding.
Deletes a workflow phase.
The deletePhase() function returns a Promise when the specified phase
has been deleted.
This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see Retrieving IDs.
function deletePhase(phaseId: string): Promise<void>;ID of the phase to delete.
import { Permissions, webMethod } from "wix-web-module";
import { workflows } from "wix-crm-backend";
export const deletePhase = webMethod(Permissions.Anyone, (phaseId) => {
return workflows.deletePhase(phaseId);
});
// Returns a promise that resolves to void.Deprecated. This function is being discontinued in the upcoming months. We are working to provide alternatives, and we'll provide timely updates before implementing any changes. We understand that this transition might present challenges, and we appreciate your patience and understanding.
Deletes a workflow.
The deleteWorkflow() function returns a Promise when the specified workflow
has been deleted.
This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflow API, see Retrieving IDs.
function deleteWorkflow(workflowId: string): Promise<void>;ID of the workflow to delete.
import { Permissions, webMethod } from "wix-web-module";
import { workflows } from "wix-crm-backend";
export const deleteWorkflow = webMethod(Permissions.Anyone, (workflowId) => {
return workflows.deleteWorkflow(workflowId);
});
// Returns a promise that resolves to void.Deprecated. This function is being discontinued in the upcoming months. We are working to provide alternatives, and we'll provide timely updates before implementing any changes. We understand that this transition might present challenges, and we appreciate your patience and understanding.
Retrieves a workflow card by ID.
The getCard() function returns a Promise that resolves to the card
with the specified ID.
This function requires you to specify the ID of a card. To learn about retrieving IDs in the Workflow API, see Retrieving IDs.
function getCard(cardId: string): Promise<Card>;ID of the card to retrieve.
import { Permissions, webMethod } from "wix-web-module";
import { workflows } from "wix-crm-backend";
export const getCard = webMethod(Permissions.Anyone, (cardId) => {
return workflows.getCard(cardId);
});
// Returns a promise that resolves to
// {
// "name": "Card Name",
// "id": "63c83c38-f504-4eb8-a48c-1d77c436a678",
// "contactId": "95bc7a80-5500-4445-9c90-adc0ff1b25ac",
// "phaseId": "15bc7a80-5500-4445-9c90-adc0ff1b25ac",
// "createdDate": "2019-05-05T12:23:43Z",
// "updatedDate": "2019-05-05T12:23:43Z",
// "source": "Inbox"
// }Deprecated. This function is being discontinued in the upcoming months. We are working to provide alternatives, and we'll provide timely updates before implementing any changes. We understand that this transition might present challenges, and we appreciate your patience and understanding.
Retrieves a phase by ID.
The getPhaseInfo() function returns a Promise that resolves to the phase
with the specified ID.
This function requires you to specify the ID of a phase. To learn about retrieving IDs in the Workflow API, see Retrieving IDs.
function getPhaseInfo(phaseId: string): Promise<Phase>;ID of the phase to retrieve.
import { Permissions, webMethod } from "wix-web-module";
import { workflows } from "wix-crm-backend";
export const getPhaseInfo = webMethod(Permissions.Anyone, (phaseId) => {
return workflows.getPhaseInfo(phaseId);
});
// Returns a promise that resolves to:
// {
// name: "Phase Name",
// id: "66f6443c-884f-4b12-beae-ab864fb489db"
// }Deprecated. This function is being discontinued in the upcoming months. We are working to provide alternatives, and we'll provide timely updates before implementing any changes. We understand that this transition might present challenges, and we appreciate your patience and understanding.
Retrieves a workflow by ID.
The getWorkflowInfo() function returns a Promise that resolves to the workflow info
with the specified ID.
This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflow API, see Retrieving IDs.
function getWorkflowInfo(workflowId: string): Promise<Workflow>;ID of the workflow to retrieve.
import { Permissions, webMethod } from "wix-web-module";
import { workflows } from "wix-crm-backend";
export const getWorkflowInfo = webMethod(Permissions.Anyone, (workflowId) => {
return workflows.getWorkflowInfo(workflowId);
});
/* Returns a promise that resolves to:
*
* {
* "name": "My Workflow",
* "id": "27cb0001-a464-4e1b-91c2-83d666577b75",
* "createdDate": "2019-05-19T12:35:55.408Z",
* "description": "Workflow description"
* }
*/Deprecated. This function is being discontinued in the upcoming months. We are working to provide alternatives, and we'll provide timely updates before implementing any changes. We understand that this transition might present challenges, and we appreciate your patience and understanding.
Retrieves a list of a workflow's cards.
The listCards() function returns a Promise that resolves to a list of the
the specified workflow's cards.
Use the options parameter to specify which cards to retrieve and in which
order to retrieve them. Must use either phaseId or fetchOnlyArchived.
Cards can be sorted based on their "id", "name",
"phaseId", "createdDate", "updatedDate", "source", and "position".
If no limit parameter is passed, the first 50 cards are returned. Sort order
defaults to by "phaseId" and then by "position" ascending.
This function requires you to specify the ID of a workflow. To learn about retrieving IDs in the Workflow API, see Retrieving IDs.
function listCards(
workflowId: string,
options: ListCardOptions,
): Promise<CardList>;ID of the workflow to retrieve cards from.
Options to use when retrieving the list of cards.
import { Permissions, webMethod } from "wix-web-module";
import { workflows } from "wix-crm-backend";
export const listCards = webMethod(
Permissions.Anyone,
(workflowId, phaseId) => {
return workflows.listCards(workflowId, {
phaseId: phaseId,
limit: 2,
skip: 10,
order: {
field: "name",
sort: "asc",
},
});
},
);
/* Returns a promise that resolves to:
* {
* "items": [
* {
* "createdDate": "2019-05-21T12:21:10Z",
* "updatedDate": "2019-05-21T12:21:10Z",
* "name": "This is a card",
* "id": "5ae263d5-0fdc-4378-9172-655d010cc6d1",
* "contactId": "c4d0545b-f748-4e1f-93fb-6d8609fb2fb4",
* "phaseId": "15bc7a80-5500-4445-9c90-adc0ff1b25ac",
* "source": "Inbox",
* },
* {
* "createdDate": "2019-05-21T12:21:10Z",
* "updatedDate": "2019-05-21T12:21:10Z",
* "name": "This is another card",
* "id": "63d55ae2-9172-0fdc-4378-10cc6d1655d0",
* "contactId": "c4d0545b-f748-4e1f-93fb-6d8609fb2fb4",
* "phaseId": "25bc7a80-5500-4445-9c90-adc0ff1b25ac",
* "source": "Wix Forms",
* }
* ],
* "length": 2,
* "totalCount": 100,
* "pageSize": 2,
* "totalPages": 50,
* "currentPage": 5
* }
*/