Workflows

List Workflows

get

/v3/workflows

Get a list of all Workflows

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

owner_idstringRequired

page_sizeintegerOptional

page_numberintegerOptional

searchstringOptional

eventstring[]Optional

actionsstring[]Optional

tagsstring[]Optional

ownerstring[]Optional

created_bystring[]Optional

updated_bystring[]Optional

enabledstringOptional

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get

/v3/workflows

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Workflows.List(ctx, operations.WorkflowsListWorkflowsRequest{
        OwnerID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V3WorkflowsListWorkflowAPIResponse != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

{
  "data": [
    {
      "id": 1,
      "owner_id": "text",
      "title": "text",
      "description": "text",
      "enabled": true,
      "trigger": "text",
      "filters": {
        "type": "text",
        "key": "text",
        "value": "text",
        "condition": "and",
        "filters": [
          "[Circular Reference]"
        ]
      },
      "tags": [
        {
          "color": "text",
          "key": "text",
          "value": "text"
        }
      ],
      "actions": [
        {
          "name": "text",
          "data": {
            "runbooks": [
              {
                "id": "text",
                "name": "text"
              }
            ]
          }
        }
      ],
      "created_at": "text",
      "created_by": "text",
      "updated_at": "text",
      "updated_by": "text"
    }
  ],
  "meta": {
    "total_count": 1,
    "acl": {}
  }
}

Create Workflow

post

/v3/workflows

Create a Workflow

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

titlestringRequired

descriptionstringOptional

owner_idstringRequired

owner_typestring · enumOptionalPossible values:

triggerstring · enumRequiredPossible values:

enabledbooleanOptional

Responses

201

The request has succeeded and a new resource has been created as a result.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

post

/v3/workflows

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Workflows.Create(ctx, components.V3WorkflowsCreateWorkflowRequest{
        Title: "<value>",
        OwnerID: "<id>",
        Trigger: components.V3WorkflowsWorkflowTriggerIncidentAcknowledged,
        Filters: components.V3WorkflowsCreateWorkflowFilter{},
        Actions: []components.V3WorkflowsActionRequest{
            components.CreateV3WorkflowsActionRequestV3WorkflowsSqTriggerManualWebhook(
                components.V3WorkflowsSqTriggerManualWebhook{
                    Name: components.V3WorkflowsSqTriggerManualWebhookNameSqTriggerManualWebhook,
                    Data: components.V3WorkflowsSqTriggerManualWebhookData{
                        ID: "<id>",
                    },
                },
            ),
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": 1,
    "owner_id": "text",
    "title": "text",
    "description": "text",
    "enabled": true,
    "trigger": "text",
    "filters": {
      "type": "text",
      "key": "text",
      "value": "text",
      "condition": "and",
      "filters": [
        {
          "type": "text",
          "key": "text",
          "value": "text",
          "condition": "and",
          "filters": "[Circular Reference]"
        }
      ]
    },
    "tags": [
      {
        "color": "text",
        "key": "text",
        "value": "text"
      }
    ],
    "actions": [
      {
        "name": "text",
        "data": {
          "runbooks": [
            {
              "id": "text",
              "name": "text"
            }
          ]
        }
      }
    ],
    "created_at": "text",
    "created_by": "text",
    "updated_at": "text",
    "updated_by": "text"
  }
}

Bulk Enable/Disable Workflows

put

/v3/workflows/enable

Bulk enable or disable workflows

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

owner_idstringRequired

enabledbooleanRequired

workflow_idsinteger · int32[]Required

Responses

204

There is no content to send for this request, but the headers may be useful.

*/*

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

put

/v3/workflows/enable

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Workflows.BulkEnableDisable(ctx, components.V3WorkflowsBulkEnableDisableWorkflowsRequest{
        OwnerID: "<id>",
        Enabled: false,
        WorkflowIds: []int{
            124939,
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Body != nil {
        // handle response
    }
}

{}

Get Workflow By ID

get

/v3/workflows/{workflowID}

Get a workflow by ID

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workflowIDstringRequired

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get

/v3/workflows/{workflowID}

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Workflows.GetByID(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.V3WorkflowsGetWorkflowByIDResponse != nil {
        // handle response
    }
}

{
  "data": {
    "id": 1,
    "owner_id": "text",
    "title": "text",
    "description": "text",
    "enabled": true,
    "trigger": "text",
    "filters": {
      "type": "text",
      "key": "text",
      "value": "text",
      "condition": "and",
      "filters": [
        {
          "type": "text",
          "key": "text",
          "value": "text",
          "condition": "and",
          "filters": "[Circular Reference]"
        }
      ]
    },
    "tags": [
      {
        "color": "text",
        "key": "text",
        "value": "text"
      }
    ],
    "actions": [
      {
        "name": "text",
        "data": {
          "runbooks": [
            {
              "id": "text",
              "name": "text"
            }
          ]
        }
      }
    ],
    "created_at": "text",
    "created_by": "text",
    "updated_at": "text",
    "updated_by": "text"
  }
}

Delete Workflow

delete

/v3/workflows/{workflowID}

Delete a workflow by ID

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workflowIDstringRequired

Responses

204

There is no content to send for this request, but the headers may be useful.

*/*

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

delete

/v3/workflows/{workflowID}

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Workflows.Delete(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Body != nil {
        // handle response
    }
}

{}

Update Workflow

patch

/v3/workflows/{workflowID}

Update a Workflow

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workflowIDstringRequired

Body

titlestringOptional

descriptionstringOptional

owner_idstringOptional

owner_typestring · enumOptionalPossible values:

triggerstring · enumOptionalPossible values:

enabledbooleanOptional

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

patch

/v3/workflows/{workflowID}

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Workflows.Update(ctx, "<id>", components.V3WorkflowsCreateWorkflowRequestUpdate{})
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": 1,
    "owner_id": "text",
    "title": "text",
    "description": "text",
    "enabled": true,
    "trigger": "text",
    "filters": {
      "type": "text",
      "key": "text",
      "value": "text",
      "condition": "and",
      "filters": [
        {
          "type": "text",
          "key": "text",
          "value": "text",
          "condition": "and",
          "filters": [
            "[Circular Reference]"
          ]
        }
      ]
    },
    "tags": [
      {
        "color": "text",
        "key": "text",
        "value": "text"
      }
    ],
    "actions": [
      {
        "name": "text",
        "data": {
          "runbooks": [
            {
              "id": "text",
              "name": "text"
            }
          ]
        }
      }
    ],
    "created_at": "text",
    "created_by": "text",
    "updated_at": "text",
    "updated_by": "text"
  }
}

Create Action

post

/v3/workflows/{workflowID}/actions

Create an Action for a workflow

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workflowIDstringRequired

Body

anyOptional

Responses

201

The request has succeeded and a new resource has been created as a result.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

post

/v3/workflows/{workflowID}/actions

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Workflows.Actions.Create(ctx, "<id>", components.CreateV3WorkflowsActionRequestV3WorkflowsSqCreateStatusPageIssue(
        components.V3WorkflowsSqCreateStatusPageIssue{
            Name: components.V3WorkflowsSqCreateStatusPageIssueNameSqAddStatusPageIssue,
            Data: components.V3WorkflowsSqCreateStatusPageIssueData{
                ComponentAndImpact: []components.V3WorkflowsComponentAndImpact{},
                IssueTitle: "<value>",
                PageStatusID: 179034,
                StatusAndMessage: []components.V3WorkflowsIssueStatusAndMessage{
                    components.V3WorkflowsIssueStatusAndMessage{
                        Messages: []string{
                            "<value 1>",
                            "<value 2>",
                            "<value 3>",
                        },
                        StatusID: 692068,
                    },
                },
                StatusPageID: 368871,
            },
        },
    ))
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "name": "text",
    "data": {
      "runbooks": [
        {
          "id": "text",
          "name": "text"
        }
      ]
    }
  }
}

Update Actions Order

patch

/v3/workflows/{workflowID}/actions/reorder

Update action order in a workflow

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workflowIDstringRequired

Body

action_orderinteger · int32[]Optional

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

patch

/v3/workflows/{workflowID}/actions/reorder

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Workflows.UpdateActionsOrder(ctx, "<id>", components.V3WorkflowsUpdateActionsOrderRequest{})
    if err != nil {
        log.Fatal(err)
    }
    if res.V3WorkflowsUpdateActionsOrderResponse != nil {
        // handle response
    }
}

{
  "data": {
    "action_order": [
      1
    ]
  }
}

Get Workflow Action By ID

get

/v3/workflows/{workflowID}/actions/{actionID}

Get workflow action by ID

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workflowIDstringRequired

actionIDstringRequired

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get

/v3/workflows/{workflowID}/actions/{actionID}

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Workflows.GetAction(ctx, "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": 1,
    "workflow_id": 1,
    "name": "text",
    "data": null
  }
}

Delete Workflow Action

delete

/v3/workflows/{workflowID}/actions/{actionID}

Delete an action by action ID

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workflowIDstringRequired

actionIDstringRequired

Responses

204

There is no content to send for this request, but the headers may be useful.

*/*

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

delete

/v3/workflows/{workflowID}/actions/{actionID}

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Workflows.DeleteAction(ctx, "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Body != nil {
        // handle response
    }
}

{}

Update Workflow Action

patch

/v3/workflows/{workflowID}/actions/{actionID}

Update an action by action ID

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workflowIDstringRequired

actionIDstringRequired

Body

anyOptional

Responses

200

The request has succeeded.

application/json

anyOptional

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

patch

/v3/workflows/{workflowID}/actions/{actionID}

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Workflows.UpdateAction(ctx, "<id>", "<id>", components.CreateV3WorkflowsActionRequestUpdateAny(
        map[string]any{
            "name": "slack_message_channel",
        },
    ))
    if err != nil {
        log.Fatal(err)
    }
    if res.V3WorkflowsActionResponse != nil {
        // handle response
    }
}

{
  "name": "text",
  "data": {
    "runbooks": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
}

Enable/Disable Workflow

patch

/v3/workflows/{workflowID}/enable

Enable or disable workflow by ID

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workflowIDstringRequired

Body

enabledbooleanOptional

Responses

204

There is no content to send for this request, but the headers may be useful.

*/*

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

patch

/v3/workflows/{workflowID}/enable

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Workflows.ToggleEnable(ctx, "<id>", components.V3WorkflowsEnableDisableWorkflowRequest{})
    if err != nil {
        log.Fatal(err)
    }
    if res.Body != nil {
        // handle response
    }
}

{}

Get Workflow Logs

get

/v3/workflows/{workflowID}/logs

Get workflow logs

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

workflowIDstringRequired

Query parameters

page_sizeintegerOptional

page_numberintegerOptional

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get

/v3/workflows/{workflowID}/logs

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Workflows.GetLogs(ctx, "<id>", nil, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.V3WorkflowsGetWorkflowLogsResponse != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

{
  "data": [
    {
      "id": "text",
      "status": "queued",
      "incident_id": "text",
      "action_execution": "text",
      "message": "text",
      "executed_at": "text"
    }
  ],
  "meta": {
    "total_count": 1
  }
}

PreviousWebforms NextSchedule

Last updated 3 days ago

Good morning

hashtagList Workflows

hashtagCreate Workflow

hashtagBulk Enable/Disable Workflows

hashtagGet Workflow By ID

hashtagDelete Workflow

hashtagUpdate Workflow

hashtagCreate Action

hashtagUpdate Actions Order

hashtagGet Workflow Action By ID

hashtagDelete Workflow Action

hashtagUpdate Workflow Action

hashtagEnable/Disable Workflow

hashtagGet Workflow Logs

List Workflows

Create Workflow

Bulk Enable/Disable Workflows

Get Workflow By ID

Delete Workflow

Update Workflow

Create Action

Update Actions Order

Get Workflow Action By ID

Delete Workflow Action

Update Workflow Action

Enable/Disable Workflow

Get Workflow Logs