Bridges

Integration bridge management

All endpoints require a bearer token (oh_... API key or user JWT) and are served under https://api.orderly-hub.com. Use the Try it consoles to run a request against the Preview (test) server.

List bridges

GET/api/v1/bridges

Parameters

Name	In	Required	Type	Description
page	query	no	integer
limit	query	no	integer
status	query	no	string
type	query	no	string

Responses

200 Paginated bridge list

GET/api/v1/bridges

List bridges

API key (Bearer token)

page (query)

limit (query)

status (query)

type (query)

https://api-test.orderly-hub.com/api/v1/bridges

Create a bridge

POST/api/v1/bridges

Request body

Field	Type	Description
type	string
name	string
config	object
metadata	object

{
  "type": "string",
  "name": "Jane Doe",
  "config": {},
  "metadata": {}
}

Responses

201 Bridge created

POST/api/v1/bridges

Create a bridge

API key (Bearer token)

Request body (JSON){ "type": "string", "name": "Jane Doe", "config": {}, "metadata": {} }

https://api-test.orderly-hub.com/api/v1/bridges

Get single bridge

GET/api/v1/bridges/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Bridge details

404 Bridge not found

GET/api/v1/bridges/{id}

Get single bridge

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/bridges/

Update a bridge

PATCH/api/v1/bridges/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

Field	Type	Description
name	string
config	object
status	string
metadata	object

{
  "name": "Jane Doe",
  "config": {},
  "status": "pending",
  "metadata": {}
}

Responses

200 Bridge updated

PATCH/api/v1/bridges/{id}

Update a bridge

API key (Bearer token)

id * (path)

Request body (JSON){ "name": "Jane Doe", "config": {}, "status": "pending", "metadata": {} }

https://api-test.orderly-hub.com/api/v1/bridges/

Delete a bridge

DELETE/api/v1/bridges/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Bridge deleted

DELETE/api/v1/bridges/{id}

Delete a bridge

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/bridges/

Get available tasks for a bridge

GET/api/v1/bridges/{id}/tasks

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 List of available tasks

GET/api/v1/bridges/{id}/tasks

Get available tasks for a bridge

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/bridges//tasks

List webhooks for a bridge

GET/api/v1/bridges/{id}/webhooks

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Webhook list

GET/api/v1/bridges/{id}/webhooks

List webhooks for a bridge

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/bridges//webhooks

Register a webhook for a bridge

POST/api/v1/bridges/{id}/webhooks

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

Field	Type	Description
topic	string

{
  "topic": "string"
}

Responses

201 Webhook registered

POST/api/v1/bridges/{id}/webhooks

Register a webhook for a bridge

API key (Bearer token)

id * (path)

Request body (JSON){ "topic": "string" }

https://api-test.orderly-hub.com/api/v1/bridges//webhooks

Unregister a webhook topic

DELETE/api/v1/bridges/{id}/webhooks/{topic}

Parameters

Name	In	Required	Type	Description
id	path	yes	string
topic	path	yes	string

Responses

200 Webhook unregistered

DELETE/api/v1/bridges/{id}/webhooks/{topic}

Unregister a webhook topic

API key (Bearer token)

id * (path)

topic * (path)

https://api-test.orderly-hub.com/api/v1/bridges//webhooks/