Skip to content
Core ConceptsCLI ReferenceAPI Reference
CompozyOS RuntimeAPI Reference

Bridges

Compozy Bridges HTTP endpoints.

Audience
Operators running durable agent work
Focus
API Reference guidance shaped for scanability, day-two clarity, and operator context.

List persisted bridge instances

GET/api/bridges

Query Parameters

scope?string

Filter by bridge scope

Value in

  • "all"
  • "global"
  • "workspace"
workspace_id?string

Filter by active workspace id

workspace?string

Filter by workspace id, name, or path

q?string

Search display name, platform, extension, or effective status

platform?string

Filter by messaging platform

status?string

Filter by effective runtime status

Value in

  • "disabled"
  • "starting"
  • "ready"
  • "degraded"
  • "auth_required"
  • "error"
sort?"name"

Stable global-first display-name order

Value in

  • "name"
cursor?string

Continue after this query-bound bridge cursor

limit?integer

Maximum number of bridges to return; defaults to 50 and is capped at 200

Formatint32

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/bridges"
{  "bridge_health": {    "property1": {      "auth_failures_total": 0,      "bridge_instance_id": "string",      "degradation": {        "message": "string",        "reason": "auth_failed"      },      "delivery_backlog": 0,      "delivery_dropped_by_reason": {        "property1": 0,        "property2": 0      },      "delivery_dropped_total": 0,      "delivery_failures_total": 0,      "diagnostics": [        {          "bridge_instance_id": "string",          "degradation_reason": "auth_failed",          "kind": "unknown_destination",          "message": "string",          "next_action": "string",          "secret_slot": "string",          "severity": "info",          "source": "string",          "status": "auth_required"        }      ],      "last_error": "string",      "last_error_at": "2019-08-24T14:15:22Z",      "last_success_at": "2019-08-24T14:15:22Z",      "route_count": 0,      "status": "auth_required"    },    "property2": {      "auth_failures_total": 0,      "bridge_instance_id": "string",      "degradation": {        "message": "string",        "reason": "auth_failed"      },      "delivery_backlog": 0,      "delivery_dropped_by_reason": {        "property1": 0,        "property2": 0      },      "delivery_dropped_total": 0,      "delivery_failures_total": 0,      "diagnostics": [        {          "bridge_instance_id": "string",          "degradation_reason": "auth_failed",          "kind": "unknown_destination",          "message": "string",          "next_action": "string",          "secret_slot": "string",          "severity": "info",          "source": "string",          "status": "auth_required"        }      ],      "last_error": "string",      "last_error_at": "2019-08-24T14:15:22Z",      "last_success_at": "2019-08-24T14:15:22Z",      "route_count": 0,      "status": "auth_required"    }  },  "bridges": [    {      "created_at": "2019-08-24T14:15:22Z",      "degradation": {        "message": "string",        "reason": "auth_failed"      },      "delivery_defaults": {        "group_id": "string",        "mode": "direct-send",        "peer_id": "string",        "progress": {          "grouping": "accumulate",          "reactions": true,          "tool_progress": "off",          "typing": true        },        "thread_id": "string",        "property1": "string",        "property2": "string"      },      "display_name": "string",      "dm_policy": "open",      "enabled": true,      "extension_name": "string",      "id": "string",      "notification_suppress": true,      "platform": "string",      "provider_config": {        "property1": null,        "property2": null      },      "routing_policy": {        "include_group": true,        "include_peer": true,        "include_thread": true      },      "scope": "global",      "source": "dynamic",      "status": "auth_required",      "updated_at": "2019-08-24T14:15:22Z",      "webhook_public_url": "string",      "workspace_id": "string"    }  ],  "facets": {    "platforms": {      "property1": 0,      "property2": 0    },    "statuses": {      "auth_required": 0,      "degraded": 0,      "disabled": 0,      "error": 0,      "ready": 0,      "starting": 0    }  },  "page": {    "has_more": true,    "limit": 0,    "next_cursor": "string",    "total": 0  }}

Create a bridge instance

POST/api/bridges

Request Body

application/json

JSON request body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/bridges" \  -H "Content-Type: application/json" \  -d '{    "display_name": "string",    "enabled": true,    "extension_name": "string",    "platform": "string",    "routing_policy": {      "include_group": true,      "include_peer": true,      "include_thread": true    },    "scope": "global"  }'
{  "bridge": {    "created_at": "2019-08-24T14:15:22Z",    "degradation": {      "message": "string",      "reason": "auth_failed"    },    "delivery_defaults": {      "group_id": "string",      "mode": "direct-send",      "peer_id": "string",      "progress": {        "grouping": "accumulate",        "reactions": true,        "tool_progress": "off",        "typing": true      },      "thread_id": "string",      "property1": "string",      "property2": "string"    },    "display_name": "string",    "dm_policy": "open",    "enabled": true,    "extension_name": "string",    "id": "string",    "notification_suppress": true,    "platform": "string",    "provider_config": {      "property1": null,      "property2": null    },    "routing_policy": {      "include_group": true,      "include_peer": true,      "include_thread": true    },    "scope": "global",    "source": "dynamic",    "status": "auth_required",    "updated_at": "2019-08-24T14:15:22Z",    "webhook_public_url": "string",    "workspace_id": "string"  },  "health": {    "auth_failures_total": 0,    "bridge_instance_id": "string",    "degradation": {      "message": "string",      "reason": "auth_failed"    },    "delivery_backlog": 0,    "delivery_dropped_by_reason": {      "property1": 0,      "property2": 0    },    "delivery_dropped_total": 0,    "delivery_failures_total": 0,    "diagnostics": [      {        "bridge_instance_id": "string",        "degradation_reason": "auth_failed",        "kind": "unknown_destination",        "message": "string",        "next_action": "string",        "secret_slot": "string",        "severity": "info",        "source": "string",        "status": "auth_required"      }    ],    "last_error": "string",    "last_error_at": "2019-08-24T14:15:22Z",    "last_success_at": "2019-08-24T14:15:22Z",    "route_count": 0,    "status": "auth_required"  }}

Stream bridge health snapshots

GET/api/bridges/health/stream

Query Parameters

bridge_ids*string

Comma-separated bridge ids from the current catalog page; maximum 200

scope?string

Filter by bridge scope

Value in

  • "all"
  • "global"
  • "workspace"
workspace_id?string

Filter by active workspace id

workspace?string

Filter by workspace id, name, or path

Response Body

text/event-stream

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/bridges/health/stream?bridge_ids=string"
{  "bridge_health": {    "property1": {      "auth_failures_total": 0,      "bridge_instance_id": "string",      "degradation": {        "message": "string",        "reason": "auth_failed"      },      "delivery_backlog": 0,      "delivery_dropped_by_reason": {        "property1": 0,        "property2": 0      },      "delivery_dropped_total": 0,      "delivery_failures_total": 0,      "diagnostics": [        {          "bridge_instance_id": "string",          "degradation_reason": "auth_failed",          "kind": "unknown_destination",          "message": "string",          "next_action": "string",          "secret_slot": "string",          "severity": "info",          "source": "string",          "status": "auth_required"        }      ],      "last_error": "string",      "last_error_at": "2019-08-24T14:15:22Z",      "last_success_at": "2019-08-24T14:15:22Z",      "route_count": 0,      "status": "auth_required"    },    "property2": {      "auth_failures_total": 0,      "bridge_instance_id": "string",      "degradation": {        "message": "string",        "reason": "auth_failed"      },      "delivery_backlog": 0,      "delivery_dropped_by_reason": {        "property1": 0,        "property2": 0      },      "delivery_dropped_total": 0,      "delivery_failures_total": 0,      "diagnostics": [        {          "bridge_instance_id": "string",          "degradation_reason": "auth_failed",          "kind": "unknown_destination",          "message": "string",          "next_action": "string",          "secret_slot": "string",          "severity": "info",          "source": "string",          "status": "auth_required"        }      ],      "last_error": "string",      "last_error_at": "2019-08-24T14:15:22Z",      "last_success_at": "2019-08-24T14:15:22Z",      "route_count": 0,      "status": "auth_required"    }  },  "generated_at": "2019-08-24T14:15:22Z"}

List installed bridge-capable providers

GET/api/bridges/providers

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/bridges/providers"
{  "providers": [    {      "config_schema": {        "schema": "string",        "version": "string"      },      "description": "string",      "display_name": "string",      "enabled": true,      "extension_name": "string",      "health": "string",      "health_message": "string",      "platform": "string",      "secret_slots": [        {          "description": "string",          "name": "string",          "required": true        }      ],      "state": "string"    }  ]}

Generate a Slack app manifest for one bridge instance

GET/api/bridges/providers/slack/manifest

Query Parameters

instance*string

Slack bridge instance id

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/bridges/providers/slack/manifest?instance=string"
{  "manifest": {    "_metadata": {      "major_version": 0,      "minor_version": 0    },    "display_information": {      "background_color": "string",      "description": "string",      "name": "string"    },    "features": {      "bot_user": {        "always_online": true,        "display_name": "string"      },      "slash_commands": [        {          "command": "string",          "description": "string",          "should_escape": true,          "url": "string",          "usage_hint": "string"        }      ]    },    "oauth_config": {      "scopes": {        "bot": [          "string"        ]      }    },    "settings": {      "event_subscriptions": {        "bot_events": [          "string"        ],        "request_url": "string"      },      "interactivity": {        "is_enabled": true,        "request_url": "string"      },      "org_deploy_enabled": true,      "socket_mode_enabled": true,      "token_rotation_enabled": true    }  }}

Get one bridge instance

GET/api/bridges/{id}

Path Parameters

id*string

Bridge instance id

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/bridges/string"
{  "bridge": {    "created_at": "2019-08-24T14:15:22Z",    "degradation": {      "message": "string",      "reason": "auth_failed"    },    "delivery_defaults": {      "group_id": "string",      "mode": "direct-send",      "peer_id": "string",      "progress": {        "grouping": "accumulate",        "reactions": true,        "tool_progress": "off",        "typing": true      },      "thread_id": "string",      "property1": "string",      "property2": "string"    },    "display_name": "string",    "dm_policy": "open",    "enabled": true,    "extension_name": "string",    "id": "string",    "notification_suppress": true,    "platform": "string",    "provider_config": {      "property1": null,      "property2": null    },    "routing_policy": {      "include_group": true,      "include_peer": true,      "include_thread": true    },    "scope": "global",    "source": "dynamic",    "status": "auth_required",    "updated_at": "2019-08-24T14:15:22Z",    "webhook_public_url": "string",    "workspace_id": "string"  },  "health": {    "auth_failures_total": 0,    "bridge_instance_id": "string",    "degradation": {      "message": "string",      "reason": "auth_failed"    },    "delivery_backlog": 0,    "delivery_dropped_by_reason": {      "property1": 0,      "property2": 0    },    "delivery_dropped_total": 0,    "delivery_failures_total": 0,    "diagnostics": [      {        "bridge_instance_id": "string",        "degradation_reason": "auth_failed",        "kind": "unknown_destination",        "message": "string",        "next_action": "string",        "secret_slot": "string",        "severity": "info",        "source": "string",        "status": "auth_required"      }    ],    "last_error": "string",    "last_error_at": "2019-08-24T14:15:22Z",    "last_success_at": "2019-08-24T14:15:22Z",    "route_count": 0,    "status": "auth_required"  }}

Update mutable bridge instance fields

PATCH/api/bridges/{id}

Path Parameters

id*string

Bridge instance id

Request Body

application/json

JSON request body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/bridges/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "bridge": {    "created_at": "2019-08-24T14:15:22Z",    "degradation": {      "message": "string",      "reason": "auth_failed"    },    "delivery_defaults": {      "group_id": "string",      "mode": "direct-send",      "peer_id": "string",      "progress": {        "grouping": "accumulate",        "reactions": true,        "tool_progress": "off",        "typing": true      },      "thread_id": "string",      "property1": "string",      "property2": "string"    },    "display_name": "string",    "dm_policy": "open",    "enabled": true,    "extension_name": "string",    "id": "string",    "notification_suppress": true,    "platform": "string",    "provider_config": {      "property1": null,      "property2": null    },    "routing_policy": {      "include_group": true,      "include_peer": true,      "include_thread": true    },    "scope": "global",    "source": "dynamic",    "status": "auth_required",    "updated_at": "2019-08-24T14:15:22Z",    "webhook_public_url": "string",    "workspace_id": "string"  },  "health": {    "auth_failures_total": 0,    "bridge_instance_id": "string",    "degradation": {      "message": "string",      "reason": "auth_failed"    },    "delivery_backlog": 0,    "delivery_dropped_by_reason": {      "property1": 0,      "property2": 0    },    "delivery_dropped_total": 0,    "delivery_failures_total": 0,    "diagnostics": [      {        "bridge_instance_id": "string",        "degradation_reason": "auth_failed",        "kind": "unknown_destination",        "message": "string",        "next_action": "string",        "secret_slot": "string",        "severity": "info",        "source": "string",        "status": "auth_required"      }    ],    "last_error": "string",    "last_error_at": "2019-08-24T14:15:22Z",    "last_success_at": "2019-08-24T14:15:22Z",    "route_count": 0,    "status": "auth_required"  }}

Disable a bridge instance

POST/api/bridges/{id}/disable

Path Parameters

id*string

Bridge instance id

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/bridges/string/disable"
{  "bridge": {    "created_at": "2019-08-24T14:15:22Z",    "degradation": {      "message": "string",      "reason": "auth_failed"    },    "delivery_defaults": {      "group_id": "string",      "mode": "direct-send",      "peer_id": "string",      "progress": {        "grouping": "accumulate",        "reactions": true,        "tool_progress": "off",        "typing": true      },      "thread_id": "string",      "property1": "string",      "property2": "string"    },    "display_name": "string",    "dm_policy": "open",    "enabled": true,    "extension_name": "string",    "id": "string",    "notification_suppress": true,    "platform": "string",    "provider_config": {      "property1": null,      "property2": null    },    "routing_policy": {      "include_group": true,      "include_peer": true,      "include_thread": true    },    "scope": "global",    "source": "dynamic",    "status": "auth_required",    "updated_at": "2019-08-24T14:15:22Z",    "webhook_public_url": "string",    "workspace_id": "string"  },  "health": {    "auth_failures_total": 0,    "bridge_instance_id": "string",    "degradation": {      "message": "string",      "reason": "auth_failed"    },    "delivery_backlog": 0,    "delivery_dropped_by_reason": {      "property1": 0,      "property2": 0    },    "delivery_dropped_total": 0,    "delivery_failures_total": 0,    "diagnostics": [      {        "bridge_instance_id": "string",        "degradation_reason": "auth_failed",        "kind": "unknown_destination",        "message": "string",        "next_action": "string",        "secret_slot": "string",        "severity": "info",        "source": "string",        "status": "auth_required"      }    ],    "last_error": "string",    "last_error_at": "2019-08-24T14:15:22Z",    "last_success_at": "2019-08-24T14:15:22Z",    "route_count": 0,    "status": "auth_required"  }}

Enable a bridge instance

POST/api/bridges/{id}/enable

Path Parameters

id*string

Bridge instance id

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/bridges/string/enable"
{  "bridge": {    "created_at": "2019-08-24T14:15:22Z",    "degradation": {      "message": "string",      "reason": "auth_failed"    },    "delivery_defaults": {      "group_id": "string",      "mode": "direct-send",      "peer_id": "string",      "progress": {        "grouping": "accumulate",        "reactions": true,        "tool_progress": "off",        "typing": true      },      "thread_id": "string",      "property1": "string",      "property2": "string"    },    "display_name": "string",    "dm_policy": "open",    "enabled": true,    "extension_name": "string",    "id": "string",    "notification_suppress": true,    "platform": "string",    "provider_config": {      "property1": null,      "property2": null    },    "routing_policy": {      "include_group": true,      "include_peer": true,      "include_thread": true    },    "scope": "global",    "source": "dynamic",    "status": "auth_required",    "updated_at": "2019-08-24T14:15:22Z",    "webhook_public_url": "string",    "workspace_id": "string"  },  "health": {    "auth_failures_total": 0,    "bridge_instance_id": "string",    "degradation": {      "message": "string",      "reason": "auth_failed"    },    "delivery_backlog": 0,    "delivery_dropped_by_reason": {      "property1": 0,      "property2": 0    },    "delivery_dropped_total": 0,    "delivery_failures_total": 0,    "diagnostics": [      {        "bridge_instance_id": "string",        "degradation_reason": "auth_failed",        "kind": "unknown_destination",        "message": "string",        "next_action": "string",        "secret_slot": "string",        "severity": "info",        "source": "string",        "status": "auth_required"      }    ],    "last_error": "string",    "last_error_at": "2019-08-24T14:15:22Z",    "last_success_at": "2019-08-24T14:15:22Z",    "route_count": 0,    "status": "auth_required"  }}

Resolve a bridge target name without sending

POST/api/bridges/{id}/resolve

Path Parameters

id*string

Bridge instance id

Request Body

application/json

JSON request body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/bridges/string/resolve" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "diagnostic": {    "category": "string",    "code": "string",    "data_freshness": "string",    "doc_url": "string",    "evidence": {      "property1": null,      "property2": null    },    "id": "string",    "message": "string",    "severity": "string",    "suggested_command": "string",    "title": "string"  },  "result": {    "ambiguous": true,    "candidates": [      {        "bridge_id": "string",        "canonical_route": "string",        "capabilities": [          "string"        ],        "display_name": "string",        "last_seen_at": "2019-08-24T14:15:22Z",        "normalized": "string",        "qualifier": "string",        "target_type": "string",        "updated_at": "2019-08-24T14:15:22Z"      }    ],    "match": {      "bridge_id": "string",      "canonical_route": "string",      "capabilities": [        "string"      ],      "display_name": "string",      "last_seen_at": "2019-08-24T14:15:22Z",      "normalized": "string",      "qualifier": "string",      "target_type": "string",      "updated_at": "2019-08-24T14:15:22Z"    },    "step": 0  }}

Restart a bridge instance

POST/api/bridges/{id}/restart

Path Parameters

id*string

Bridge instance id

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/bridges/string/restart"
{  "bridge": {    "created_at": "2019-08-24T14:15:22Z",    "degradation": {      "message": "string",      "reason": "auth_failed"    },    "delivery_defaults": {      "group_id": "string",      "mode": "direct-send",      "peer_id": "string",      "progress": {        "grouping": "accumulate",        "reactions": true,        "tool_progress": "off",        "typing": true      },      "thread_id": "string",      "property1": "string",      "property2": "string"    },    "display_name": "string",    "dm_policy": "open",    "enabled": true,    "extension_name": "string",    "id": "string",    "notification_suppress": true,    "platform": "string",    "provider_config": {      "property1": null,      "property2": null    },    "routing_policy": {      "include_group": true,      "include_peer": true,      "include_thread": true    },    "scope": "global",    "source": "dynamic",    "status": "auth_required",    "updated_at": "2019-08-24T14:15:22Z",    "webhook_public_url": "string",    "workspace_id": "string"  },  "health": {    "auth_failures_total": 0,    "bridge_instance_id": "string",    "degradation": {      "message": "string",      "reason": "auth_failed"    },    "delivery_backlog": 0,    "delivery_dropped_by_reason": {      "property1": 0,      "property2": 0    },    "delivery_dropped_total": 0,    "delivery_failures_total": 0,    "diagnostics": [      {        "bridge_instance_id": "string",        "degradation_reason": "auth_failed",        "kind": "unknown_destination",        "message": "string",        "next_action": "string",        "secret_slot": "string",        "severity": "info",        "source": "string",        "status": "auth_required"      }    ],    "last_error": "string",    "last_error_at": "2019-08-24T14:15:22Z",    "last_success_at": "2019-08-24T14:15:22Z",    "route_count": 0,    "status": "auth_required"  }}

List routes owned by a bridge instance

GET/api/bridges/{id}/routes

Path Parameters

id*string

Bridge instance id

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/bridges/string/routes"
{  "routes": [    {      "agent_name": "string",      "bridge_instance_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "group_id": "string",      "last_activity_at": "2019-08-24T14:15:22Z",      "peer_id": "string",      "routing_key_hash": "string",      "scope": "global",      "session_id": "string",      "thread_id": "string",      "updated_at": "2019-08-24T14:15:22Z",      "workspace_id": "string"    }  ]}

List persisted secret bindings for a bridge instance

GET/api/bridges/{id}/secret-bindings

Path Parameters

id*string

Bridge instance id

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/bridges/string/secret-bindings"
{  "bindings": [    {      "binding_name": "string",      "bridge_instance_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "kind": "string",      "secret_ref": "string",      "updated_at": "2019-08-24T14:15:22Z"    }  ]}

Delete one bridge secret binding

DELETE/api/bridges/{id}/secret-bindings/{binding_name}

Path Parameters

id*string

Bridge instance id

binding_name*string

Bridge provider secret slot name

Response Body

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/bridges/string/secret-bindings/string"
Empty

Create or update one bridge secret binding

PUT/api/bridges/{id}/secret-bindings/{binding_name}

Path Parameters

id*string

Bridge instance id

binding_name*string

Bridge provider secret slot name

Request Body

application/json

JSON request body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/bridges/string/secret-bindings/string" \  -H "Content-Type: application/json" \  -d '{    "kind": "string",    "secret_ref": "string"  }'
{  "binding": {    "binding_name": "string",    "bridge_instance_id": "string",    "created_at": "2019-08-24T14:15:22Z",    "kind": "string",    "secret_ref": "string",    "updated_at": "2019-08-24T14:15:22Z"  }}

Send one real message through the bridge provider

POST/api/bridges/{id}/send-test

Path Parameters

id*string

Bridge instance id

Request Body

application/json

JSON request body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/bridges/string/send-test" \  -H "Content-Type: application/json" \  -d '{    "message": "string",    "target": {}  }'
{  "bridge_instance_id": "string",  "delivery_id": "string",  "delivery_target": {    "bridge_instance_id": "string",    "group_id": "string",    "mode": "direct-send",    "peer_id": "string",    "thread_id": "string"  },  "error": {    "message": "string"  },  "remote_message_id": "string",  "status": "delivered"}

List discovered targets for a bridge instance

GET/api/bridges/{id}/targets

Path Parameters

id*string

Bridge instance id

Query Parameters

q?string

Filter targets by display name, qualifier, or route

limit?integer

Maximum targets to return

Formatint32

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/bridges/string/targets"
{  "bridge_id": "string",  "cache_stale": true,  "generated_at": "2019-08-24T14:15:22Z",  "last_successful_refresh_at": "2019-08-24T14:15:22Z",  "targets": [    {      "bridge_id": "string",      "canonical_route": "string",      "capabilities": [        "string"      ],      "display_name": "string",      "last_seen_at": "2019-08-24T14:15:22Z",      "normalized": "string",      "qualifier": "string",      "target_type": "string",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "total": 0}

Resolve a typed outbound delivery target for a bridge instance

POST/api/bridges/{id}/test-delivery

Path Parameters

id*string

Bridge instance id

Request Body

application/json

JSON request body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/bridges/string/test-delivery" \  -H "Content-Type: application/json" \  -d '{    "target": {}  }'
{  "delivery_target": {    "bridge_instance_id": "string",    "group_id": "string",    "mode": "direct-send",    "peer_id": "string",    "thread_id": "string"  },  "message": "string",  "status": "string"}

Run live provider checks without changing bridge lifecycle state

POST/api/bridges/{id}/verify

Path Parameters

id*string

Bridge instance id

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/bridges/string/verify"
{  "bridge_instance_id": "string",  "checks": [    {      "check": "string",      "remediation": "string",      "status": "pass"    }  ]}

Register the configured provider webhook

POST/api/bridges/{id}/webhook/register

Path Parameters

id*string

Bridge instance id

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/bridges/string/webhook/register"
{  "bridge_instance_id": "string",  "remediation": "string",  "status": "pass"}

Loops

Compozy Loops HTTP endpoints.

Notifications

Compozy Notifications HTTP endpoints.