List webhook configs
Retrieve webhook configurations by lifecycle status and optional category.
query Parameters
statusStatus of resource
idCategoryOptional category ID to filter by
List webhook configs › Responses
List of webhook configs
idWebhookConfigwebhookConfigNamestatustargetTypeenabledidCategoryCategory ID. Empty if uncategorized
categoryNameFind webhook config by ID
Retrieve a webhook configuration by ID.
query Parameters
idWebhookConfigThe ID of the webhook config
Find webhook config by ID › Responses
The requested webhook config
idWebhookConfigID of the webhook configuration
webhookConfigNameWebhook config's name.
descriptionidCategoryCategory ID. Empty if uncategorized
statusenabledWhether delivery is enabled for this webhook config
targetTypeurlAbsolute webhook destination URL
Additional request headers for webhook delivery
Basic auth read model. Password is write-only and never returned by REST read endpoints.
Find webhook configs by ID list
Retrieve all webhook configurations with the specified IDs.
query Parameters
idWebhookConfigsComma-separated webhook config IDs to retrieve
Find webhook configs by ID list › Responses
List of webhook configs with the specified IDs
idWebhookConfigID of the webhook configuration
webhookConfigNameWebhook config's name.
descriptionidCategoryCategory ID. Empty if uncategorized
statusenabledWhether delivery is enabled for this webhook config
targetTypeurlAbsolute webhook destination URL
Additional request headers for webhook delivery
Basic auth read model. Password is write-only and never returned by REST read endpoints.
Save webhook config
Update an existing webhook configuration. The id cannot be changed.
Save webhook config › Request Body
idWebhookConfigID of the webhook configuration
webhookConfigNameWebhook config's name.
descriptionidCategoryCategory ID. Empty if uncategorized
statusenabledWhether delivery is enabled for this webhook config
targetTypeurlAbsolute webhook destination URL
Additional request headers for webhook delivery
Save webhook config › Responses
Webhook config updated successfully
Create webhook config
Create a new webhook configuration
Create webhook config › Request Body
idWebhookConfigID of the webhook configuration
webhookConfigNameWebhook config's name.
descriptionidCategoryCategory ID. Empty if uncategorized
statusenabledWhether delivery is enabled for this webhook config
targetTypeurlAbsolute webhook destination URL
Additional request headers for webhook delivery
Create webhook config › Responses
Webhook config created successfully
Duplicate webhook config
Create duplicate of existing webhook configuration.
query Parameters
idWebhookConfigID of the webhook config to duplicate.
Duplicate webhook config › Request Body
nameName for the new asset
parentIdOptional parent/category ID for the new asset
Optional field overrides to merge into the duplicated asset. Keys are JSON field names (e.g. baseURL, trackingFieldSlots). Protected fields (ID, owner, status) cannot be changed via this field — they are always set by the server after the merge.
Duplicate webhook config › Responses
Webhook config duplicated successfully
idID of the newly created asset