Message Brokers | API Reference (WIP)

Index

get

Pagination

Pagination is available for this request. Please see the section on using pagination for more details.

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

flows
flows_count
flowsExists
messageBrokerQueues
messageBrokerQueues_count
messageBrokerQueuesExists
variables
variables_count
variablesExists
flowMessageBrokerQueues
flowMessageBrokerQueues_count
flowMessageBrokerQueuesExists

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

name
description
host
protocol
auth_type
port

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

name
description
host
port
protocol
auth_type

Authorizations

Query parameters

filter[name]stringOptional

Filter results by name.

filter[description]stringOptional

Filter results by description.

filter[host]stringOptional

Filter results by host.

filter[protocol]stringOptional

Filter results by protocol.

filter[auth_type]stringOptional

Filter results by auth_type.

filter[port]stringOptional

Filter results by port.

includestringOptional

Comma-separated list of relationships to include. Available: flows, messageBrokerQueues, variables, flowMessageBrokerQueues

sortstringOptional

Sort field. Prefix with - for descending. Available: name, description, host, port, protocol, auth_type

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/message-brokers

GET /api/v1/message-brokers HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "description": "A description of the resource",
      "host": "example_host",
      "port": 1,
      "protocol": "HTTP",
      "auth_type": "example_auth_type",
      "variables": "example_variables",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/message-brokers",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/message-brokers?page=1",
    "last": "https://api.example.com/api/v1/message-brokers?page=1",
    "prev": null,
    "next": null
  }
}

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

name

string

☑

description

string

☑

host

string

☑

port

integer

☑

protocol

☑

auth_type

☑

Authorizations

Body

descriptionstring · max: 100Required

hoststringRequired

portintegerRequired

protocolstring · enumRequiredPossible values:

auth_typestringRequired

namestring · max: 40RequiredPattern: ^[a-zA-Z0-9 -]+$

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/message-brokers

POST /api/v1/message-brokers HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 148

{
  "description": "A description of the resource",
  "host": "example_host",
  "port": 1,
  "protocol": "HTTP",
  "auth_type": "example_auth_type",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "description": "A description of the resource",
    "host": "example_host",
    "port": 1,
    "protocol": "HTTP",
    "auth_type": "example_auth_type",
    "variables": "example_variables",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Show

get

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

flows
flows_count
flowsExists
messageBrokerQueues
messageBrokerQueues_count
messageBrokerQueuesExists
variables
variables_count
variablesExists
flowMessageBrokerQueues
flowMessageBrokerQueues_count
flowMessageBrokerQueuesExists

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

name
description
host
protocol
auth_type
port

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

name
description
host
port
protocol
auth_type

Authorizations

Path parameters

message_brokerstringRequired

The message broker identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

filter[description]stringOptional

Filter results by description.

filter[host]stringOptional

Filter results by host.

filter[protocol]stringOptional

Filter results by protocol.

filter[auth_type]stringOptional

Filter results by auth_type.

filter[port]stringOptional

Filter results by port.

includestringOptional

Comma-separated list of relationships to include. Available: flows, messageBrokerQueues, variables, flowMessageBrokerQueues

sortstringOptional

Sort field. Prefix with - for descending. Available: name, description, host, port, protocol, auth_type

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/message-brokers/{message_broker}

GET /api/v1/message-brokers/{message_broker} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "description": "A description of the resource",
    "host": "example_host",
    "port": 1,
    "protocol": "HTTP",
    "auth_type": "example_auth_type",
    "variables": "example_variables",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Update

put

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

name

string

description

string

host

string

port

integer

protocol

auth_type

variables

variables.*.id

string

☑

variables.*.key

string

variables.*.value

string

variables.*.label

string

variables.*.secret

variables.*.locked

variables.*.pivot.alias

string

variables.*.pivot.configurable

variables.*.pivot.required

variables.*.pivot.advanced

Authorizations

Path parameters

message_brokerstringRequired

The message broker identifier.

Body

descriptionstring · max: 100Optional

hoststringOptional

portintegerOptional

protocolstring · enumOptionalPossible values:

auth_typestringOptional

namestring · max: 40OptionalPattern: ^[a-zA-Z0-9 -]+$

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/message-brokers/{message_broker}

PUT /api/v1/message-brokers/{message_broker} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "description": "A description of the resource",
  "host": "example_host",
  "port": 1,
  "protocol": "HTTP",
  "auth_type": "example_auth_type",
  "variables": "example_variables",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "description": "A description of the resource",
    "host": "example_host",
    "port": 1,
    "protocol": "HTTP",
    "auth_type": "example_auth_type",
    "variables": "example_variables",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Destroy

delete

Delete a message broker.

Authorizations

Path parameters

message_brokerstringRequired

The message broker identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

delete

/api/v1/message-brokers/{message_broker}

DELETE /api/v1/message-brokers/{message_broker} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

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

Index

get

Pagination

Pagination is available for this request. Please see the section on using pagination for more details.

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

flows
flows_count
flowsExists
messageBroker
messageBroker_count
messageBrokerExists

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

name
message_broker_id

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

name
message_broker_id

Authorizations

Path parameters

message_brokerstringRequired

The message broker identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

filter[message_broker_id]stringOptional

Filter results by message_broker_id.

includestringOptional

Comma-separated list of relationships to include. Available: flows, messageBroker

sortstringOptional

Sort field. Prefix with - for descending. Available: name, message_broker_id

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/message-brokers/{message_broker}/message-broker-queues

GET /api/v1/message-brokers/{message_broker}/message-broker-queues HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "flow_id": 1,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/message-brokers/{message_broker}/message-broker-queues",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/message-brokers/{message_broker}/message-broker-queues?page=1",
    "last": "https://api.example.com/api/v1/message-brokers/{message_broker}/message-broker-queues?page=1",
    "prev": null,
    "next": null
  }
}

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

name

string

☑

Authorizations

Path parameters

message_brokerstringRequired

The message broker identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/message-brokers/{message_broker}/message-broker-queues

POST /api/v1/message-brokers/{message_broker}/message-broker-queues HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "flow_id": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Show

get

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

flows
flows_count
flowsExists
messageBroker
messageBroker_count
messageBrokerExists

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

name
message_broker_id

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

name
message_broker_id

Authorizations

Path parameters

message_brokerstringRequired

The message broker identifier.

message_broker_queuestringRequired

The message broker queue identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

filter[message_broker_id]stringOptional

Filter results by message_broker_id.

includestringOptional

Comma-separated list of relationships to include. Available: flows, messageBroker

sortstringOptional

Sort field. Prefix with - for descending. Available: name, message_broker_id

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/message-brokers/{message_broker}/message-broker-queues/{message_broker_queue}

GET /api/v1/message-brokers/{message_broker}/message-broker-queues/{message_broker_queue} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "flow_id": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Update

put

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

name

string

Authorizations

Path parameters

message_brokerstringRequired

The message broker identifier.

message_broker_queuestringRequired

The message broker queue identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/message-brokers/{message_broker}/message-broker-queues/{message_broker_queue}

PUT /api/v1/message-brokers/{message_broker}/message-broker-queues/{message_broker_queue} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "flow_id": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Destroy

delete

Delete a message broker queue.

Authorizations

Path parameters

message_brokerstringRequired

The message broker identifier.

message_broker_queuestringRequired

The message broker queue identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

delete

/api/v1/message-brokers/{message_broker}/message-broker-queues/{message_broker_queue}

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

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

hashtagIndex

hashtagPagination

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Sorts

hashtagStore

hashtagValidation Rules

hashtagShow

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Sorts

hashtagUpdate

hashtagValidation Rules

hashtagDestroy

hashtagIndex

hashtagPagination

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Sorts

hashtagStore

hashtagValidation Rules

hashtagShow

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Sorts

hashtagUpdate

hashtagValidation Rules

hashtagDestroy

Index

Pagination

Available Includes

Available Filters

Available Sorts

Store

Validation Rules

Show

Available Includes

Available Filters

Available Sorts

Update

Validation Rules

Destroy

Index

Pagination

Available Includes

Available Filters

Available Sorts

Store

Validation Rules

Show

Available Includes

Available Filters

Available Sorts

Update

Validation Rules

Destroy