Skip to main content
Server path: /hookdeck-connections | Type: Application | PCID required: Yes

Tools

ToolDescription
hookdeck_connections_count_connectionsCount connections
hookdeck_connections_count_destinationsCount destinations
hookdeck_connections_count_sourcesCount sources
hookdeck_connections_create_connectionCreate a connection
hookdeck_connections_create_destinationCreate a destination
hookdeck_connections_create_sourceCreate a source
hookdeck_connections_delete_connectionDelete a connection
hookdeck_connections_delete_destinationDelete a destination
hookdeck_connections_delete_sourceDelete a source
hookdeck_connections_disable_connectionDisable a connection
hookdeck_connections_disable_connection_archiveDisable a connection
hookdeck_connections_disable_destinationDisable a destination
hookdeck_connections_disable_destination_archiveDisable a destination
hookdeck_connections_disable_sourceDisable a source
hookdeck_connections_disable_source_archiveDisable a source
hookdeck_connections_enable_connectionEnable a connection
hookdeck_connections_enable_connection_unarchiveEnable a connection
hookdeck_connections_enable_destinationEnable a destination
hookdeck_connections_enable_destination_unarchiveEnable a destination
hookdeck_connections_enable_sourceEnable a source
hookdeck_connections_enable_source_unarchiveEnable a source
hookdeck_connections_get_connectionGet a single connection
hookdeck_connections_get_connectionsGet connections
hookdeck_connections_get_destinationGet a destination
hookdeck_connections_get_destinationsGet destinations
hookdeck_connections_get_sourceGet a source
hookdeck_connections_get_sourcesGet sources
hookdeck_connections_pause_connectionPause a connection
hookdeck_connections_unpause_connectionUnpause a connection
hookdeck_connections_update_connectionUpdate a connection
hookdeck_connections_update_destinationUpdate a destination
hookdeck_connections_update_sourceUpdate a source
hookdeck_connections_upsert_connectionUpdate or create a connection
hookdeck_connections_upsert_destinationUpdate or create a destination
hookdeck_connections_upsert_sourceUpdate or create a source

hookdeck_connections_count_connections

Count connections Parameters:
ParameterTypeRequiredDefaultDescription
destination_idstring[]NoFilter by associated destination IDs
source_idstring[]NoFilter by associated source IDs
disabledbooleanNoInclude disabled resources in the response
disabled_atobjectNoDate the connection was disabled
paused_atobjectNoDate the connection was paused

hookdeck_connections_count_destinations

Count destinations Parameters:
ParameterTypeRequiredDefaultDescription
idstring[]NoFilter by destination IDs
namestring[]NoThe destination name
disabledbooleanNoInclude disabled resources in the response
disabled_atstring[]NoDate the destination was disabled

hookdeck_connections_count_sources

Count sources

hookdeck_connections_create_connection

Create a connection Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoDescription for the connection
destinationobjectNoDestination input object
destination_idstringNoID of a destination to bind to the connection
namestringNoA unique name of the connection for the source
rulesany[]NoThe rules value
sourceobjectNoSource input object
source_idstringNoID of a source to bind to the connection

hookdeck_connections_create_destination

Create a destination Parameters:
ParameterTypeRequiredDefaultDescription
configobjectNoThe type configs for the specified type
descriptionstringNoDescription for the destination
namestringYesName for the destination
typestringNoType of the destination

hookdeck_connections_create_source

Create a source Parameters:
ParameterTypeRequiredDefaultDescription
configobjectNoThe type configs for the specified type
descriptionstringNoDescription for the source
namestringYesA unique name for the source
typestringNoType of the source

hookdeck_connections_delete_connection

Delete a connection Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value

hookdeck_connections_delete_destination

Delete a destination Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value

hookdeck_connections_delete_source

Delete a source Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value

hookdeck_connections_disable_connection

Disable a connection Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesConnection ID

hookdeck_connections_disable_connection_archive

Disable a connection Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesConnection ID

hookdeck_connections_disable_destination

Disable a destination Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesDestination ID

hookdeck_connections_disable_destination_archive

Disable a destination Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesDestination ID

hookdeck_connections_disable_source

Disable a source Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesSource ID

hookdeck_connections_disable_source_archive

Disable a source Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesSource ID

hookdeck_connections_enable_connection

Enable a connection Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesConnection ID

hookdeck_connections_enable_connection_unarchive

Enable a connection Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesConnection ID

hookdeck_connections_enable_destination

Enable a destination Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesDestination ID

hookdeck_connections_enable_destination_unarchive

Enable a destination Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesDestination ID

hookdeck_connections_enable_source

Enable a source Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesSource ID

hookdeck_connections_enable_source_unarchive

Enable a source Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesSource ID

hookdeck_connections_get_connection

Get a single connection Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesConnection ID

hookdeck_connections_get_connections

Get connections Parameters:
ParameterTypeRequiredDefaultDescription
idstring[]NoFilter by connection IDs
nameobjectNoFilter by connection name
destination_idstring[]NoFilter by associated destination IDs
source_idstring[]NoFilter by associated source IDs
disabledbooleanNoInclude disabled resources in the response
disabled_atobjectNoDate the connection was disabled
full_namestringNoFuzzy match the concatenated source and connection name. The source name and connection name must be separated by ” -> “
paused_atobjectNoDate the connection was paused
order_bystring[]NoSort key(s)
dirstring[]NoSort direction(s)
limitintegerNoResult set size
nextstringNoThe ID to provide in the query to get the next set of results
prevstringNoThe ID to provide in the query to get the previous set of results

hookdeck_connections_get_destination

Get a destination Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoRelated resources to include
idstringYesDestination ID

hookdeck_connections_get_destinations

Get destinations Parameters:
ParameterTypeRequiredDefaultDescription
idstring[]NoFilter by destination IDs
nameobjectNoThe destination name
typestring[]NoFilter by destination type
disabledbooleanNoInclude disabled resources in the response
disabled_atobjectNoDate the destination was disabled
order_bystringNoSort key
dirstringNoSort direction
limitintegerNoResult set size
nextstringNoThe ID to provide in the query to get the next set of results
prevstringNoThe ID to provide in the query to get the previous set of results

hookdeck_connections_get_source

Get a source Parameters:
ParameterTypeRequiredDefaultDescription
includestringNoRelated resources to include
idstringYesSource ID

hookdeck_connections_get_sources

Get sources Parameters:
ParameterTypeRequiredDefaultDescription
idstring[]NoFilter by source IDs
nameobjectNoThe source name
typestring[]NoFilter by source type
disabledbooleanNoInclude disabled resources in the response
disabled_atobjectNoDate the source was disabled
order_bystringNoSort key
dirstringNoSort direction
limitintegerNoResult set size
nextstringNoThe ID to provide in the query to get the next set of results
prevstringNoThe ID to provide in the query to get the previous set of results

hookdeck_connections_pause_connection

Pause a connection Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesConnection ID

hookdeck_connections_unpause_connection

Unpause a connection Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesConnection ID

hookdeck_connections_update_connection

Update a connection Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesConnection ID
descriptionstringNoDescription for the connection
namestringNoThe name value
rulesany[]NoThe rules value

hookdeck_connections_update_destination

Update a destination Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesDestination ID
configobjectNoThe type configs for the specified type
descriptionstringNoDescription for the destination
namestringNoName for the destination
typestringNoType of the destination

hookdeck_connections_update_source

Update a source Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesSource ID
configobjectNoThe type configs for the specified type
descriptionstringNoDescription for the source
namestringNoA unique name for the source
typestringNoType of the source

hookdeck_connections_upsert_connection

Update or create a connection Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoDescription for the connection
destinationobjectNoDestination input object
destination_idstringNoID of a destination to bind to the connection
namestringNoA unique name of the connection for the source
rulesany[]NoThe rules value
sourceobjectNoSource input object
source_idstringNoID of a source to bind to the connection

hookdeck_connections_upsert_destination

Update or create a destination Parameters:
ParameterTypeRequiredDefaultDescription
configobjectNoThe type configs for the specified type
descriptionstringNoDescription for the destination
namestringYesName for the destination
typestringNoType of the destination

hookdeck_connections_upsert_source

Update or create a source Parameters:
ParameterTypeRequiredDefaultDescription
configobjectNoThe type configs for the specified type
descriptionstringNoDescription for the source
namestringYesA unique name for the source
typestringNoType of the source