/hookdeck-connections | Type: Application | PCID required: Yes
Tools
hookdeck_connections_count_connections
Count connections Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
destination_id | string[] | No | — | Filter by associated destination IDs |
source_id | string[] | No | — | Filter by associated source IDs |
disabled | boolean | No | — | Include disabled resources in the response |
disabled_at | object | No | — | Date the connection was disabled |
paused_at | object | No | — | Date the connection was paused |
hookdeck_connections_count_destinations
Count destinations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string[] | No | — | Filter by destination IDs |
name | string[] | No | — | The destination name |
disabled | boolean | No | — | Include disabled resources in the response |
disabled_at | string[] | No | — | Date the destination was disabled |
hookdeck_connections_count_sources
Count sourceshookdeck_connections_create_connection
Create a connection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | Description for the connection |
destination | object | No | — | Destination input object |
destination_id | string | No | — | ID of a destination to bind to the connection |
name | string | No | — | A unique name of the connection for the source |
rules | any[] | No | — | The rules value |
source | object | No | — | Source input object |
source_id | string | No | — | ID of a source to bind to the connection |
hookdeck_connections_create_destination
Create a destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
config | object | No | — | The type configs for the specified type |
description | string | No | — | Description for the destination |
name | string | Yes | — | Name for the destination |
type | string | No | — | Type of the destination |
hookdeck_connections_create_source
Create a source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
config | object | No | — | The type configs for the specified type |
description | string | No | — | Description for the source |
name | string | Yes | — | A unique name for the source |
type | string | No | — | Type of the source |
hookdeck_connections_delete_connection
Delete a connection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
hookdeck_connections_delete_destination
Delete a destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
hookdeck_connections_delete_source
Delete a source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
hookdeck_connections_disable_connection
Disable a connection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Connection ID |
hookdeck_connections_disable_connection_archive
Disable a connection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Connection ID |
hookdeck_connections_disable_destination
Disable a destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Destination ID |
hookdeck_connections_disable_destination_archive
Disable a destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Destination ID |
hookdeck_connections_disable_source
Disable a source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Source ID |
hookdeck_connections_disable_source_archive
Disable a source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Source ID |
hookdeck_connections_enable_connection
Enable a connection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Connection ID |
hookdeck_connections_enable_connection_unarchive
Enable a connection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Connection ID |
hookdeck_connections_enable_destination
Enable a destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Destination ID |
hookdeck_connections_enable_destination_unarchive
Enable a destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Destination ID |
hookdeck_connections_enable_source
Enable a source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Source ID |
hookdeck_connections_enable_source_unarchive
Enable a source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Source ID |
hookdeck_connections_get_connection
Get a single connection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Connection ID |
hookdeck_connections_get_connections
Get connections Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string[] | No | — | Filter by connection IDs |
name | object | No | — | Filter by connection name |
destination_id | string[] | No | — | Filter by associated destination IDs |
source_id | string[] | No | — | Filter by associated source IDs |
disabled | boolean | No | — | Include disabled resources in the response |
disabled_at | object | No | — | Date the connection was disabled |
full_name | string | No | — | Fuzzy match the concatenated source and connection name. The source name and connection name must be separated by ” -> “ |
paused_at | object | No | — | Date the connection was paused |
order_by | string[] | No | — | Sort key(s) |
dir | string[] | No | — | Sort direction(s) |
limit | integer | No | — | Result set size |
next | string | No | — | The ID to provide in the query to get the next set of results |
prev | string | No | — | The ID to provide in the query to get the previous set of results |
hookdeck_connections_get_destination
Get a destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | Related resources to include |
id | string | Yes | — | Destination ID |
hookdeck_connections_get_destinations
Get destinations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string[] | No | — | Filter by destination IDs |
name | object | No | — | The destination name |
type | string[] | No | — | Filter by destination type |
disabled | boolean | No | — | Include disabled resources in the response |
disabled_at | object | No | — | Date the destination was disabled |
order_by | string | No | — | Sort key |
dir | string | No | — | Sort direction |
limit | integer | No | — | Result set size |
next | string | No | — | The ID to provide in the query to get the next set of results |
prev | string | No | — | The ID to provide in the query to get the previous set of results |
hookdeck_connections_get_source
Get a source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | Related resources to include |
id | string | Yes | — | Source ID |
hookdeck_connections_get_sources
Get sources Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string[] | No | — | Filter by source IDs |
name | object | No | — | The source name |
type | string[] | No | — | Filter by source type |
disabled | boolean | No | — | Include disabled resources in the response |
disabled_at | object | No | — | Date the source was disabled |
order_by | string | No | — | Sort key |
dir | string | No | — | Sort direction |
limit | integer | No | — | Result set size |
next | string | No | — | The ID to provide in the query to get the next set of results |
prev | string | No | — | The ID to provide in the query to get the previous set of results |
hookdeck_connections_pause_connection
Pause a connection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Connection ID |
hookdeck_connections_unpause_connection
Unpause a connection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Connection ID |
hookdeck_connections_update_connection
Update a connection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Connection ID |
description | string | No | — | Description for the connection |
name | string | No | — | The name value |
rules | any[] | No | — | The rules value |
hookdeck_connections_update_destination
Update a destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Destination ID |
config | object | No | — | The type configs for the specified type |
description | string | No | — | Description for the destination |
name | string | No | — | Name for the destination |
type | string | No | — | Type of the destination |
hookdeck_connections_update_source
Update a source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Source ID |
config | object | No | — | The type configs for the specified type |
description | string | No | — | Description for the source |
name | string | No | — | A unique name for the source |
type | string | No | — | Type of the source |
hookdeck_connections_upsert_connection
Update or create a connection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | Description for the connection |
destination | object | No | — | Destination input object |
destination_id | string | No | — | ID of a destination to bind to the connection |
name | string | No | — | A unique name of the connection for the source |
rules | any[] | No | — | The rules value |
source | object | No | — | Source input object |
source_id | string | No | — | ID of a source to bind to the connection |
hookdeck_connections_upsert_destination
Update or create a destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
config | object | No | — | The type configs for the specified type |
description | string | No | — | Description for the destination |
name | string | Yes | — | Name for the destination |
type | string | No | — | Type of the destination |
hookdeck_connections_upsert_source
Update or create a source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
config | object | No | — | The type configs for the specified type |
description | string | No | — | Description for the source |
name | string | Yes | — | A unique name for the source |
type | string | No | — | Type of the source |

