Workflows

Overview

Available Operations

• list - List Workflows

• create - Create Workflow

• bulk_enable_disable - Bulk Enable/Disable Workflows

• delete - Delete Workflow

• get_by_id - Get Workflow By ID

• update - Update Workflow

• update_actions_order - Update Actions Order

• delete_action - Delete Workflow Action

• update_action - Update Workflow Action

• enable_disable - Enable/Disable Workflow

list

Get a list of all Workflows

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.workflows.list(owner_id="<id>")

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter	Type	Required	Description
owner_id	str	✔️	N/A
page_size	Optional[int]	➖	N/A
page_number	Optional[int]	➖	N/A
search	Optional[str]	➖	N/A
event	List[str]	➖	N/A
actions	List[str]	➖	N/A
tags	List[str]	➖	N/A
owner	List[str]	➖	N/A
created_by	List[str]	➖	N/A
updated_by	List[str]	➖	N/A
enabled	Optional[str]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.WorkflowsListWorkflowsResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

create

Create a Workflow

Example Usage

from squadcast_sdk import SquadcastSDK, models


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.workflows.create(title="<value>", owner_id="<id>", trigger="incident_acknowledged", filters=models.V3WorkflowsCreateWorkflowFilter(), actions=[
        {
            "name": "sq_trigger_manual_webhook",
            "data": {
                "id": "<id>",
            },
        },
    ])

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
title	str	✔️	N/A
owner_id	str	✔️	N/A
trigger	models.V3WorkflowsWorkflowTrigger	✔️	N/A
filters	models.V3WorkflowsCreateWorkflowFilter	✔️	N/A
actions	List[models.V3WorkflowsActionRequest]	✔️	N/A
description	Optional[str]	➖	N/A
owner_type	Optional[models.V3WorkflowsCreateWorkflowRequestOwnerType]	➖	N/A
entity_owner	Optional[models.V3WorkflowsEntityOwner]	➖	N/A
tags	List[models.V3WorkflowsTag]	➖	N/A
enabled	Optional[bool]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.WorkflowsCreateWorkflowResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

bulk_enable_disable

Bulk enable or disable workflows

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.workflows.bulk_enable_disable(owner_id="<id>", enabled=False, workflow_ids=[
        124939,
    ])

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
owner_id	str	✔️	N/A
enabled	bool	✔️	N/A
workflow_ids	List[int]	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

bytes

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

delete

Delete a workflow by ID

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.workflows.delete(workflow_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
workflow_id	str	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

bytes

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

get_by_id

Get a workflow by ID

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.workflows.get_by_id(workflow_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
workflow_id	str	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.V3WorkflowsGetWorkflowByIDResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

update

Update a Workflow

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.workflows.update(workflow_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
workflow_id	str	✔️	N/A
title	Optional[str]	➖	N/A
description	Optional[str]	➖	N/A
owner_id	Optional[str]	➖	N/A
owner_type	Optional[models.V3WorkflowsCreateWorkflowRequestUpdateOwnerType]	➖	N/A
entity_owner	Optional[models.V3WorkflowsEntityOwnerUpdate]	➖	N/A
tags	List[models.V3WorkflowsTag]	➖	N/A
trigger	Optional[models.V3WorkflowsWorkflowTrigger]	➖	N/A
filters	Optional[models.V3WorkflowsCreateWorkflowFilter]	➖	N/A
actions	List[models.V3WorkflowsActionRequest]	➖	N/A
enabled	Optional[bool]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.WorkflowsUpdateWorkflowResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

update_actions_order

Update action order in a workflow

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.workflows.update_actions_order(workflow_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
workflow_id	str	✔️	N/A
action_order	List[int]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.V3WorkflowsUpdateActionsOrderResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

delete_action

Delete an action by action ID

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.workflows.delete_action(workflow_id="<id>", action_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
workflow_id	str	✔️	N/A
action_id	str	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

bytes

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

update_action

Update an action by action ID

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.workflows.update_action(workflow_id="<id>", action_id="<id>", v3_workflows_action_request_update={
        "name": "slack_message_channel",
    })

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
workflow_id	str	✔️	N/A
action_id	str	✔️	N/A
v3_workflows_action_request_update	models.V3WorkflowsActionRequestUpdate	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.V3WorkflowsActionResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*

enable_disable

Enable or disable workflow by ID

Example Usage

from squadcast_sdk import SquadcastSDK


with SquadcastSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as ss_client:

    res = ss_client.workflows.enable_disable(workflow_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
workflow_id	str	✔️	N/A
enabled	Optional[bool]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

bytes

Errors

Error Type	Status Code	Content Type
errors.BadRequestError	400	application/json
errors.UnauthorizedError	401	application/json
errors.PaymentRequiredError	402	application/json
errors.ForbiddenError	403	application/json
errors.NotFoundError	404	application/json
errors.ConflictError	409	application/json
errors.UnprocessableEntityError	422	application/json
errors.InternalServerError	500	application/json
errors.BadGatewayError	502	application/json
errors.ServiceUnavailableError	503	application/json
errors.GatewayTimeoutError	504	application/json
errors.SDKDefaultError	4XX, 5XX	*/*