/hookdeck-config | Type: Application | PCID required: Yes
Tools
hookdeck_config_add_custom_domain
Add a custom domain to the project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
hostname | string | Yes | — | The custom hostname to attach to the project |
hookdeck_config_attach_integration_to_source
Attach an integration to a source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Integration ID |
source_id | string | Yes | — | Source ID |
hookdeck_config_create_bookmark
Create a bookmark Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_data_id | string | Yes | — | ID of the event data to bookmark |
label | string | Yes | — | Descriptive name of the bookmark |
name | string | No | — | A unique, human-friendly name for the bookmark |
webhook_id | string | Yes | — | ID of the associated connection (webhook) |
hookdeck_config_create_integration
Create an integration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
configs | object | No | — | Decrypted Key/Value object of the associated configuration for that provider |
features | string[] | No | — | List of features to enable (see features list above) |
label | string | No | — | Label of the integration |
provider | string | No | — | The provider value |
hookdeck_config_create_issue_trigger
Create an issue trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channels | object | Yes | — | Notification channels object for the specific channel type |
configs | object | No | — | Configuration object for the specific issue type selected |
name | string | No | — | Optional unique name to use as reference when using the API |
type | string | Yes | — | Issue type |
hookdeck_config_create_transformation
Create a transformation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
code | string | Yes | — | JavaScript code to be executed as string |
env | object | No | — | Key-value environment variables to be passed to the transformation |
name | string | Yes | — | A unique, human-friendly name for the transformation |
hookdeck_config_delete_bookmark
Delete a bookmark Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Bookmark ID |
hookdeck_config_delete_custom_domain
Removes a custom domain from the project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
domain_id | string | Yes | — | Domain Id |
hookdeck_config_delete_integration
Delete an integration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Integration ID |
hookdeck_config_delete_issue_trigger
Delete an issue trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Issue trigger ID |
hookdeck_config_delete_transformation
Delete a transformation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Transformation ID |
hookdeck_config_detach_integration_to_source
Detach an integration from a source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Integration ID |
source_id | string | Yes | — | Source ID |
hookdeck_config_disable_issue_trigger
Disable an issue trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Issue trigger ID |
hookdeck_config_dismiss_issue
Dismiss an issue Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Issue ID |
hookdeck_config_enable_issue_trigger
Enable an issue trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Issue trigger ID |
hookdeck_config_get_bookmark
Get a single bookmark Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Bookmark ID |
hookdeck_config_get_bookmark_raw_body
Get a bookmark raw body data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Bookmark ID |
hookdeck_config_get_bookmarks
Get bookmarks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string[] | No | — | Filter by bookmark IDs |
name | string[] | No | — | Filter by bookmark name |
webhook_id | string[] | No | — | Filter by associated connection (webhook) ID |
event_data_id | string[] | No | — | Filter by associated event data ID |
label | string[] | No | — | Filter by label |
last_used_at | object | No | — | Filter by last used date |
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_config_get_integration
Get an integration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Integration ID |
hookdeck_config_get_integrations
Get integrations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
label | string | No | — | The integration label |
provider | string | No | — | The provider value |
hookdeck_config_get_issue
Get a single issue Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Issue ID |
hookdeck_config_get_issue_count
Get the number of issues Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string[] | No | — | Filter by Issue IDs |
issue_trigger_id | string[] | No | — | Filter by Issue trigger IDs |
type | string[] | No | — | Filter by Issue types |
status | string[] | No | — | Filter by Issue statuses |
merged_with | string[] | No | — | Filter by Merged Issue IDs |
aggregation_keys | object | No | — | Filter by aggregation keys |
created_at | object | No | — | Filter by created dates |
first_seen_at | object | No | — | Filter by first seen dates |
last_seen_at | object | No | — | Filter by last seen dates |
dismissed_at | object | No | — | Filter by dismissed dates |
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_config_get_issue_trigger
Get a single issue trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Issue trigger ID |
hookdeck_config_get_issue_triggers
Get issue triggers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | No | — | Filter by issue trigger name |
type | string[] | No | — | Issue type |
disabled_at | object | No | — | Date when the issue trigger was disabled |
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_config_get_issues
Get issues Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string[] | No | — | Filter by Issue IDs |
issue_trigger_id | string[] | No | — | Filter by Issue trigger IDs |
type | string[] | No | — | Filter by Issue types |
status | string[] | No | — | Filter by Issue statuses |
merged_with | string[] | No | — | Filter by Merged Issue IDs |
aggregation_keys | object | No | — | Filter by aggregation keys |
created_at | object | No | — | Filter by created dates |
first_seen_at | object | No | — | Filter by first seen dates |
last_seen_at | object | No | — | Filter by last seen dates |
dismissed_at | object | No | — | Filter by dismissed dates |
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_config_get_transformation
Get a transformation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Transformation ID |
hookdeck_config_get_transformation_execution
Get a transformation execution Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Transformation ID |
execution_id | string | Yes | — | Execution ID |
hookdeck_config_get_transformation_executions
Get transformation executions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
log_level | string[] | No | — | Log level of the execution |
webhook_id | string[] | No | — | ID of the connection the execution was run for |
issue_id | string[] | No | — | ID of the associated issue |
created_at | object | No | — | ISO date of the transformation’s execution |
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 |
id | string | Yes | — | Transformation ID |
hookdeck_config_get_transformations
Get transformations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string[] | No | — | Filter by transformation IDs |
name | object | No | — | Filter by transformation name |
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_config_get_transformations_count
Get transformations counthookdeck_config_list_custom_domains
List all custom domains and their verification statuses for the projecthookdeck_config_test_transformation
Test a transformation code Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
code | string | No | — | JavaScript code to be executed |
env | object | No | — | Key-value environment variables to be passed to the transformation |
event_id | string | No | — | Event Id |
request | object | No | — | Request input to use for the transformation execution |
transformation_id | string | No | — | Transformation ID |
webhook_id | string | No | — | ID of the connection (webhook) to use for the execution context |
hookdeck_config_toggle_webhook_notifications
Toggle webhook notifications for the project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
enabled | boolean | Yes | — | Enable or disable webhook notifications on the project |
source_id | string | Yes | — | The Hookdeck Source to send the webhook to |
topics | string[] | Yes | — | List of topics to send notifications for |
hookdeck_config_trigger_bookmark
Trigger a bookmark Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Bookmark ID |
hookdeck_config_update_bookmark
Update a bookmark Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Bookmark ID |
event_data_id | string | No | — | ID of the event data to bookmark |
label | string | No | — | Descriptive name of the bookmark |
name | string | No | — | A unique, human-friendly name for the bookmark |
webhook_id | string | No | — | ID of the associated connection (webhook) |
hookdeck_config_update_integration
Update an integration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Integration ID |
configs | object | No | — | Decrypted Key/Value object of the associated configuration for that provider |
features | string[] | No | — | List of features to enable (see features list above) |
label | string | No | — | Label of the integration |
provider | string | No | — | The provider value |
hookdeck_config_update_issue
Update issue Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Issue ID |
status | string | Yes | — | New status |
hookdeck_config_update_issue_trigger
Update an issue trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Issue trigger ID |
channels | object | No | — | Notification channels object for the specific channel type |
configs | object | No | — | Configuration object for the specific issue type selected |
disabled_at | string | No | — | Date when the issue trigger was disabled |
name | string | No | — | Optional unique name to use as reference when using the API |
hookdeck_config_update_transformation
Update a transformation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Transformation ID |
code | string | No | — | JavaScript code to be executed |
env | object | No | — | Key-value environment variables to be passed to the transformation |
name | string | No | — | A unique, human-friendly name for the transformation |
hookdeck_config_upsert_issue_trigger
Create or update an issue trigger Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channels | object | Yes | — | Notification channels object for the specific channel type |
configs | object | No | — | Configuration object for the specific issue type selected |
name | string | Yes | — | Required unique name to use as reference when using the API |
type | string | Yes | — | Issue type |
hookdeck_config_upsert_transformation
Update or create a transformation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
code | string | Yes | — | JavaScript code to be executed as string |
env | object | No | — | Key-value environment variables to be passed to the transformation |
name | string | Yes | — | A unique, human-friendly name for the transformation |

