Skip to main content

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​

NameInRequiredTypeDescription
pagequerynointeger
limitquerynointeger
statusquerynostring
typequerynostring

Responses​

200 Paginated bridge list

GET/api/v1/bridges

List bridges

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

Create a bridge​

POST/api/v1/bridges

Request body​

FieldTypeDescription
typestring
namestring
configobject
metadataobject
{
"type": "string",
"name": "Jane Doe",
"config": {},
"metadata": {}
}

Responses​

201 Bridge created

POST/api/v1/bridges

Create a bridge

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

Get single bridge​

GET/api/v1/bridges/{id}

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Responses​

200 Bridge details

404 Bridge not found

GET/api/v1/bridges/{id}

Get single bridge

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

Update a bridge​

PATCH/api/v1/bridges/{id}

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Request body​

FieldTypeDescription
namestring
configobject
statusstring
metadataobject
{
"name": "Jane Doe",
"config": {},
"status": "pending",
"metadata": {}
}

Responses​

200 Bridge updated

PATCH/api/v1/bridges/{id}

Update a bridge

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

Delete a bridge​

DELETE/api/v1/bridges/{id}

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Responses​

200 Bridge deleted

DELETE/api/v1/bridges/{id}

Delete a bridge

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

Get available tasks for a bridge​

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

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Responses​

200 List of available tasks

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

Get available tasks for a bridge

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

List webhooks for a bridge​

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

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Responses​

200 Webhook list

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

List webhooks for a bridge

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

Register a webhook for a bridge​

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

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Request body​

FieldTypeDescription
topicstring
{
"topic": "string"
}

Responses​

201 Webhook registered

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

Register a webhook for a bridge

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

Unregister a webhook topic​

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

Parameters​

NameInRequiredTypeDescription
idpathyesstring
topicpathyesstring

Responses​

200 Webhook unregistered

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

Unregister a webhook topic

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