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

Tools

ToolDescription
hookdeck_config_add_custom_domainAdd a custom domain to the project
hookdeck_config_attach_integration_to_sourceAttach an integration to a source
hookdeck_config_create_bookmarkCreate a bookmark
hookdeck_config_create_integrationCreate an integration
hookdeck_config_create_issue_triggerCreate an issue trigger
hookdeck_config_create_transformationCreate a transformation
hookdeck_config_delete_bookmarkDelete a bookmark
hookdeck_config_delete_custom_domainRemoves a custom domain from the project
hookdeck_config_delete_integrationDelete an integration
hookdeck_config_delete_issue_triggerDelete an issue trigger
hookdeck_config_delete_transformationDelete a transformation
hookdeck_config_detach_integration_to_sourceDetach an integration from a source
hookdeck_config_disable_issue_triggerDisable an issue trigger
hookdeck_config_dismiss_issueDismiss an issue
hookdeck_config_enable_issue_triggerEnable an issue trigger
hookdeck_config_get_bookmarkGet a single bookmark
hookdeck_config_get_bookmark_raw_bodyGet a bookmark raw body data
hookdeck_config_get_bookmarksGet bookmarks
hookdeck_config_get_integrationGet an integration
hookdeck_config_get_integrationsGet integrations
hookdeck_config_get_issueGet a single issue
hookdeck_config_get_issue_countGet the number of issues
hookdeck_config_get_issue_triggerGet a single issue trigger
hookdeck_config_get_issue_triggersGet issue triggers
hookdeck_config_get_issuesGet issues
hookdeck_config_get_transformationGet a transformation
hookdeck_config_get_transformation_executionGet a transformation execution
hookdeck_config_get_transformation_executionsGet transformation executions
hookdeck_config_get_transformationsGet transformations
hookdeck_config_get_transformations_countGet transformations count
hookdeck_config_list_custom_domainsList all custom domains and their verification statuses for the project
hookdeck_config_test_transformationTest a transformation code
hookdeck_config_toggle_webhook_notificationsToggle webhook notifications for the project
hookdeck_config_trigger_bookmarkTrigger a bookmark
hookdeck_config_update_bookmarkUpdate a bookmark
hookdeck_config_update_integrationUpdate an integration
hookdeck_config_update_issueUpdate issue
hookdeck_config_update_issue_triggerUpdate an issue trigger
hookdeck_config_update_transformationUpdate a transformation
hookdeck_config_upsert_issue_triggerCreate or update an issue trigger
hookdeck_config_upsert_transformationUpdate or create a transformation

hookdeck_config_add_custom_domain

Add a custom domain to the project Parameters:
ParameterTypeRequiredDefaultDescription
hostnamestringYesThe custom hostname to attach to the project

hookdeck_config_attach_integration_to_source

Attach an integration to a source Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesIntegration ID
source_idstringYesSource ID

hookdeck_config_create_bookmark

Create a bookmark Parameters:
ParameterTypeRequiredDefaultDescription
event_data_idstringYesID of the event data to bookmark
labelstringYesDescriptive name of the bookmark
namestringNoA unique, human-friendly name for the bookmark
webhook_idstringYesID of the associated connection (webhook)

hookdeck_config_create_integration

Create an integration Parameters:
ParameterTypeRequiredDefaultDescription
configsobjectNoDecrypted Key/Value object of the associated configuration for that provider
featuresstring[]NoList of features to enable (see features list above)
labelstringNoLabel of the integration
providerstringNoThe provider value

hookdeck_config_create_issue_trigger

Create an issue trigger Parameters:
ParameterTypeRequiredDefaultDescription
channelsobjectYesNotification channels object for the specific channel type
configsobjectNoConfiguration object for the specific issue type selected
namestringNoOptional unique name to use as reference when using the API
typestringYesIssue type

hookdeck_config_create_transformation

Create a transformation Parameters:
ParameterTypeRequiredDefaultDescription
codestringYesJavaScript code to be executed as string
envobjectNoKey-value environment variables to be passed to the transformation
namestringYesA unique, human-friendly name for the transformation

hookdeck_config_delete_bookmark

Delete a bookmark Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesBookmark ID

hookdeck_config_delete_custom_domain

Removes a custom domain from the project Parameters:
ParameterTypeRequiredDefaultDescription
domain_idstringYesDomain Id

hookdeck_config_delete_integration

Delete an integration Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesIntegration ID

hookdeck_config_delete_issue_trigger

Delete an issue trigger Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesIssue trigger ID

hookdeck_config_delete_transformation

Delete a transformation Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesTransformation ID

hookdeck_config_detach_integration_to_source

Detach an integration from a source Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesIntegration ID
source_idstringYesSource ID

hookdeck_config_disable_issue_trigger

Disable an issue trigger Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesIssue trigger ID

hookdeck_config_dismiss_issue

Dismiss an issue Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesIssue ID

hookdeck_config_enable_issue_trigger

Enable an issue trigger Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesIssue trigger ID

hookdeck_config_get_bookmark

Get a single bookmark Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesBookmark ID

hookdeck_config_get_bookmark_raw_body

Get a bookmark raw body data Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesBookmark ID

hookdeck_config_get_bookmarks

Get bookmarks Parameters:
ParameterTypeRequiredDefaultDescription
idstring[]NoFilter by bookmark IDs
namestring[]NoFilter by bookmark name
webhook_idstring[]NoFilter by associated connection (webhook) ID
event_data_idstring[]NoFilter by associated event data ID
labelstring[]NoFilter by label
last_used_atobjectNoFilter by last used date
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_config_get_integration

Get an integration Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesIntegration ID

hookdeck_config_get_integrations

Get integrations Parameters:
ParameterTypeRequiredDefaultDescription
labelstringNoThe integration label
providerstringNoThe provider value

hookdeck_config_get_issue

Get a single issue Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesIssue ID

hookdeck_config_get_issue_count

Get the number of issues Parameters:
ParameterTypeRequiredDefaultDescription
idstring[]NoFilter by Issue IDs
issue_trigger_idstring[]NoFilter by Issue trigger IDs
typestring[]NoFilter by Issue types
statusstring[]NoFilter by Issue statuses
merged_withstring[]NoFilter by Merged Issue IDs
aggregation_keysobjectNoFilter by aggregation keys
created_atobjectNoFilter by created dates
first_seen_atobjectNoFilter by first seen dates
last_seen_atobjectNoFilter by last seen dates
dismissed_atobjectNoFilter by dismissed dates
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_config_get_issue_trigger

Get a single issue trigger Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesIssue trigger ID

hookdeck_config_get_issue_triggers

Get issue triggers Parameters:
ParameterTypeRequiredDefaultDescription
namestringNoFilter by issue trigger name
typestring[]NoIssue type
disabled_atobjectNoDate when the issue trigger was disabled
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_config_get_issues

Get issues Parameters:
ParameterTypeRequiredDefaultDescription
idstring[]NoFilter by Issue IDs
issue_trigger_idstring[]NoFilter by Issue trigger IDs
typestring[]NoFilter by Issue types
statusstring[]NoFilter by Issue statuses
merged_withstring[]NoFilter by Merged Issue IDs
aggregation_keysobjectNoFilter by aggregation keys
created_atobjectNoFilter by created dates
first_seen_atobjectNoFilter by first seen dates
last_seen_atobjectNoFilter by last seen dates
dismissed_atobjectNoFilter by dismissed dates
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_config_get_transformation

Get a transformation Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesTransformation ID

hookdeck_config_get_transformation_execution

Get a transformation execution Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesTransformation ID
execution_idstringYesExecution ID

hookdeck_config_get_transformation_executions

Get transformation executions Parameters:
ParameterTypeRequiredDefaultDescription
log_levelstring[]NoLog level of the execution
webhook_idstring[]NoID of the connection the execution was run for
issue_idstring[]NoID of the associated issue
created_atobjectNoISO date of the transformation’s execution
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
idstringYesTransformation ID

hookdeck_config_get_transformations

Get transformations Parameters:
ParameterTypeRequiredDefaultDescription
idstring[]NoFilter by transformation IDs
nameobjectNoFilter by transformation name
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_config_get_transformations_count

Get transformations count

hookdeck_config_list_custom_domains

List all custom domains and their verification statuses for the project

hookdeck_config_test_transformation

Test a transformation code Parameters:
ParameterTypeRequiredDefaultDescription
codestringNoJavaScript code to be executed
envobjectNoKey-value environment variables to be passed to the transformation
event_idstringNoEvent Id
requestobjectNoRequest input to use for the transformation execution
transformation_idstringNoTransformation ID
webhook_idstringNoID of the connection (webhook) to use for the execution context

hookdeck_config_toggle_webhook_notifications

Toggle webhook notifications for the project Parameters:
ParameterTypeRequiredDefaultDescription
enabledbooleanYesEnable or disable webhook notifications on the project
source_idstringYesThe Hookdeck Source to send the webhook to
topicsstring[]YesList of topics to send notifications for

hookdeck_config_trigger_bookmark

Trigger a bookmark Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesBookmark ID

hookdeck_config_update_bookmark

Update a bookmark Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesBookmark ID
event_data_idstringNoID of the event data to bookmark
labelstringNoDescriptive name of the bookmark
namestringNoA unique, human-friendly name for the bookmark
webhook_idstringNoID of the associated connection (webhook)

hookdeck_config_update_integration

Update an integration Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesIntegration ID
configsobjectNoDecrypted Key/Value object of the associated configuration for that provider
featuresstring[]NoList of features to enable (see features list above)
labelstringNoLabel of the integration
providerstringNoThe provider value

hookdeck_config_update_issue

Update issue Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesIssue ID
statusstringYesNew status

hookdeck_config_update_issue_trigger

Update an issue trigger Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesIssue trigger ID
channelsobjectNoNotification channels object for the specific channel type
configsobjectNoConfiguration object for the specific issue type selected
disabled_atstringNoDate when the issue trigger was disabled
namestringNoOptional unique name to use as reference when using the API

hookdeck_config_update_transformation

Update a transformation Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesTransformation ID
codestringNoJavaScript code to be executed
envobjectNoKey-value environment variables to be passed to the transformation
namestringNoA unique, human-friendly name for the transformation

hookdeck_config_upsert_issue_trigger

Create or update an issue trigger Parameters:
ParameterTypeRequiredDefaultDescription
channelsobjectYesNotification channels object for the specific channel type
configsobjectNoConfiguration object for the specific issue type selected
namestringYesRequired unique name to use as reference when using the API
typestringYesIssue type

hookdeck_config_upsert_transformation

Update or create a transformation Parameters:
ParameterTypeRequiredDefaultDescription
codestringYesJavaScript code to be executed as string
envobjectNoKey-value environment variables to be passed to the transformation
namestringYesA unique, human-friendly name for the transformation