Skip to content
Start here

Workflows

List all Workflows
client.Workflows.List(ctx, params) (*V4PagePaginationArray[WorkflowListResponse], error)
GET/accounts/{account_id}/workflows
Get Workflow details
client.Workflows.Get(ctx, workflowName, query) (*WorkflowGetResponse, error)
GET/accounts/{account_id}/workflows/{workflow_name}
Create/modify Workflow
client.Workflows.Update(ctx, workflowName, params) (*WorkflowUpdateResponse, error)
PUT/accounts/{account_id}/workflows/{workflow_name}
Deletes a Workflow
client.Workflows.Delete(ctx, workflowName, body) (*WorkflowDeleteResponse, error)
DELETE/accounts/{account_id}/workflows/{workflow_name}

WorkflowsInstances

List of workflow instances
client.Workflows.Instances.List(ctx, workflowName, params) (*V4PagePaginationArray[InstanceListResponse], error)
GET/accounts/{account_id}/workflows/{workflow_name}/instances
Get logs and status from instance
client.Workflows.Instances.Get(ctx, workflowName, instanceID, params) (*InstanceGetResponse, error)
GET/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}
Create a new workflow instance
client.Workflows.Instances.New(ctx, workflowName, params) (*InstanceNewResponse, error)
POST/accounts/{account_id}/workflows/{workflow_name}/instances
Batch create new Workflow instances
client.Workflows.Instances.Bulk(ctx, workflowName, params) (*SinglePage[InstanceBulkResponse], error)
POST/accounts/{account_id}/workflows/{workflow_name}/instances/batch

WorkflowsInstancesStatus

Change status of instance
client.Workflows.Instances.Status.Edit(ctx, workflowName, instanceID, params) (*InstanceStatusEditResponse, error)
PATCH/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/status

WorkflowsInstancesEvents

Send event to instance
client.Workflows.Instances.Events.New(ctx, workflowName, instanceID, eventType, params) (*InstanceEventNewResponse, error)
POST/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/events/{event_type}

WorkflowsVersions

List deployed Workflow versions
client.Workflows.Versions.List(ctx, workflowName, params) (*V4PagePaginationArray[VersionListResponse], error)
GET/accounts/{account_id}/workflows/{workflow_name}/versions
Get Workflow version details
client.Workflows.Versions.Get(ctx, workflowName, versionID, query) (*VersionGetResponse, error)
GET/accounts/{account_id}/workflows/{workflow_name}/versions/{version_id}