Message Broker Queues

Store

post

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field	Type	Required
flow_id	integer	☑

Authorizations

ApiKeyAuth

Path parameters

message_broker_queuestringRequired

The message broker queue identifier.

Body

application/json

flow_idintegerRequired

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/message-broker-queues/{message_broker_queue}/flows

HTTPcURLJavaScriptPython

POST /api/v1/message-broker-queues/{message_broker_queue}/flows HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "flow_id": 1
}

{
  "data": {
    "id": 1,
    "name": "My Example",
    "enabled_at": "2025-01-15T10:30:00.000000Z",
    "status": "Draft",
    "format": "csv",
    "body": "example_body",
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "labels": "example_labels",
    "notification_groups": "example_notification_groups",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "description": "A description of the resource",
    "layout_direction": "example_layout_direction",
    "is_enabled": {},
    "latest_version": {},
    "current_version": {},
    "deployed_version": {},
    "latest_deployed_version": [],
    "versions": [],
    "version_type_counts": [],
    "message_brokers": [],
    "message_broker_queues": [],
    "notification_group_ids": [],
    "webhooks": "example_webhooks",
    "callbacks": "example_callbacks",
    "current_version_step_count": 5,
    "current_version_connector_count": 5,
    "current_version_script_count": 5,
    "current_version_cache_count": 5,
    "current_version_data_pool_count": 5,
    "current_version_cross_ref_count": 5,
    "use_queued_time": "example_use_queued_time",
    "remove_failed_payloads": [],
    "priority": 1,
    "prod_flag": [],
    "deployments": [],
    "webhooks_count": 5,
    "callbacks_count": 5,
    "marketplace_app_id": 1,
    "blueprint_id": 1,
    "blueprint_version_number": "example_blueprint_version_number"
  }
}

Destroy

delete

Delete a flow.

Authorizations

ApiKeyAuth

Path parameters

message_broker_queuestringRequired

The message broker queue identifier.

flowstringRequired

The flow identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/message-broker-queues/{message_broker_queue}/flows/{flow}

HTTPcURLJavaScriptPython

DELETE /api/v1/message-broker-queues/{message_broker_queue}/flows/{flow} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "message": "Action completed successfully."
}