Flow Callbacks

List Flow Callbacks

get

Retrieves a paginated list of callbacks for a specific flow.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flowstringRequired

The flow identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get/api/v1/flows/{flow}/callbacks

HTTPcURLJavaScriptPython

GET /api/v1/flows/{flow}/callbacks HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "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"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/flows/{flow}/callbacks",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/flows/{flow}/callbacks?page=1",
    "last": "https://api.example.com/api/v1/flows/{flow}/callbacks?page=1",
    "prev": null,
    "next": null
  }
}

Create Flow Callback

post

Creates a new callback trigger for a specific flow.

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
status
format

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flowstringRequired

The flow identifier.

Body

application/json

statusstring · enumOptionalPossible values:

formatstring · enumOptionalPossible values:

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post/api/v1/flows/{flow}/callbacks

HTTPcURLJavaScriptPython

POST /api/v1/flows/{flow}/callbacks HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "status": "Draft",
  "format": "csv"
}

{
  "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"
  }
}

Update Flow Callback

put

Updates an existing callback for a specific flow.

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
status
format

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flowstringRequired

The flow identifier.

callbackstringRequired

The callback identifier.

Body

application/json

statusstring · enumOptionalPossible values:

formatstring · enumOptionalPossible values:

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put/api/v1/flows/{flow}/callbacks/{callback}

HTTPcURLJavaScriptPython

PUT /api/v1/flows/{flow}/callbacks/{callback} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "status": "Draft",
  "format": "csv"
}

{
  "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"
  }
}

Delete Flow Callback

delete

Permanently deletes a specific callback for a specific flow.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flowstringRequired

The flow identifier.

callbackstringRequired

The callback identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete/api/v1/flows/{flow}/callbacks/{callback}

HTTPcURLJavaScriptPython

DELETE /api/v1/flows/{flow}/callbacks/{callback} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

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